Perform an on-us cross-tenant transfer transaction

post

https://api.sandbox.braid.zone/transaction/external/transfer

Body Params

internalNote

string

length between 1 and 255

Transaction Internal Note

amount

number

required

Explicit decimal point and trailing zeros are truncated. Example: 1234.56.

senderAccountNumber

string

required

Sender account number (must belong to the calling user's tenant)

counterpartyId

int32

required

Counterparty ID with a BRAID payment instrument pointing at the recipient account

paymentInstrumentId

int32

Optional BRAID payment instrument ID. Required only when the counterparty has more than one BRAID payment instrument.

description

string

required

length between 1 and 255

Transfer description

externalId

string

length between 1 and 255

External reference ID

Headers

Idempotency-Key

string

For each new Transaction Request, the optional IdempotencyKey should be a unique identifier (UUID). If the same IdempotencyKey is used a second time for the same API, the application will not process a new transaction, but return the response of previous request. IdempotencyKey records have TTL of 7 days.

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

412Precondition Failed

422Unprocessable Entity

500Internal Server Error

503Service Unavailable