Create a Batch Settlement Schedule

Creates a Batch Settlement Schedule that can be used as the destination of a liquidation address.

POST /customers/{customerID}/batch_settlement_schedules

Create a Batch Settlement Schedule

cURL

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": {
    "external_account_id": "<string>",
    "bridge_wallet_id": "<string>",
    "wire_message": "<string>",
    "sepa_reference": "<string>",
    "swift_reference": "<string>",
    "spei_reference": "<string>",
    "reference": "<string>",
    "ach_reference": "<string>",
    "blockchain_memo": "<string>",
    "deposit_id": "<string>"
  }
}
'

200

Example

{
  "id": "<string>"
}

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.

Show child attributes

Response

200

application/json

Batch Settlement Schedule object created

id · string · required

ID of the batch settlement schedule

Required string length: 1 - 42

Pattern: [a-z0-9]*