Skip to main content

Transfer Destinations

List accounts (same merchant) that may receive a transfer from the source account.

Endpoint​

GET /api/v2/accounts/{account_uuid}/transfer-destinations

Response​

{
"items": [
{
"id": "019d2236-2511-728e-96de-27fca03a9c49",
"name": "Secondary Account",
"currency": "USD"
}
]
}

Transfer Balance

Moves funds from the source account (account_uuid in the path) to another account.

Endpoint​

POST /api/v2/accounts/{account_uuid}/transfer

Request body​

FieldTypeRequiredDescription
destinationAccountUuidstringYesTarget account UUID
amountnumber or stringYesPositive amount
currencystringNoDefault USD
descriptionstringNoMax 500 chars
{
"destinationAccountUuid": "019d2236-2511-728e-96de-27fca03a9c49",
"amount": "100.00",
"currency": "USD",
"description": "Monthly allocation"
}

Response​

May be synchronous (transaction ids) or async (status: "accepted"). Example:

{
"status": "accepted",
"message": "Transfer request accepted and is being processed",
"sourceAccountUuid": "019d2236-2511-728e-96de-27fca03a9c48",
"destinationAccountUuid": "019d2236-2511-728e-96de-27fca03a9c49",
"amount": "100.00",
"currency": "USD"
}

Or with fromTransactionId / toTransactionId when processed synchronously.

Business rules​

  • Source and destination must belong to the same merchant
  • Source must have sufficient available balance
  • Both accounts typically need isTransferAllowed: true