Skip to main content
POST
/
customers
/
{customerID}
/
batch_settlement_schedules
Create a Batch Settlement Schedule
curl --request POST \
  --url https://api.bridge.xyz/v0/customers/{customerID}/batch_settlement_schedules \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "destination": {
    "currency": "brl",
    "payment_rail": "ach",
    "external_account_id": "<string>",
    "bridge_wallet_id": "<string>",
    "wire_message": "<string>",
    "sepa_reference": "<string>",
    "swift_reference": "<string>",
    "spei_reference": "<string>",
    "reference": "<string>",
    "swift_charges": "our",
    "ach_reference": "<string>",
    "blockchain_memo": "<string>",
    "deposit_id": "<string>"
  }
}
'
{
  "id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.bridge.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Api-Key
string
header
required

Headers

​
Idempotency-Key
string
required

Path Parameters

​
customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*

Body

application/json
​
destination
object
required

The destination that Bridge will use to settle funds.

Response

Batch Settlement Schedule object created

​
id
string
required

ID of the batch settlement schedule

Required string length: 1 - 42
Pattern: [a-z0-9]*