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": "dai",
"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>"
}Create a Batch Settlement Schedule
Creates a Batch Settlement Schedule that can be used as the destination of a liquidation address.
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": "dai",
"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>"
}Authorizations
Headers
Path Parameters
A UUID that uniquely identifies a resource
1 - 42Body
The destination that Bridge will use to settle funds.
Show child attributes
Show child attributes
When eur is specified as the destination currency, the destination rail must be sepa.
dai, eur, eurc, mxn, pyusd, usd, usdb, usdc, usdt When sepa is specified as the destination payment rail, the destination currency must be eur; when swift is specified as the destination payment rail, the destination currency must be usd.
ach, wire, ach_push, ach_same_day, arbitrum, avalanche_c_chain, base, ethereum, fiat_deposit_return, optimism, polygon, sepa, solana, spei, stellar, swift, tron External bank account Bridge should send the funds to. The currency associated with the External Account must match the destination currency.
1 - 42The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the destination payment rail.
1 - 42A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 characters according to the Fedwire standard.
1 - 256A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are a-z, A-Z, 0-9, spaces, ampersand (&), hyphen (-), full stop (.), and solidus (/). If not populated, the default value is "Payment via Bridge {unique_token}".
6 - 140A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by "\n"), each line with a max length of 35 chars. The allowed characters are a-z, A-Z, 0-9, special characters (/ - ? : ( ) . , ' +), and space
1 - 190A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric a-z, A-Z, 0-9, and space
1 - 40A payment reference message for newer payment rails (e.g. Pix).
Which party will bear the charges for the SWIFT transaction. When left blank, sha will be used as the default.
our, sha A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.
1 - 10The memo to include when sending funds on chain. Only allowed for blockchains that support memos such as Stellar
A UUID that uniquely identifies a deposit
1 - 42Response
Batch Settlement Schedule object created
ID of the batch settlement schedule
1 - 42Was this page helpful?