Skip to main content
POST
Create Transfer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
destinationTenantKey
string
required

The business funds move to — a child business or your main business. Cannot equal the source.

Example:

"blm998877"

amount
object
required
reference
string
required

Your client reference for the transfer. Stored on it so you can locate it later.

Example:

"transfer-123"

sourceTenantKey
string

The business funds move from. Omit to send from your main business, or pass a child business's tenant key.

Example:

"blm123456"

Response

Transfer created response

id
string<uuid>

The transfer id. Track it via the platform disbursements endpoint filtered to type=TRANSFER.

Example:

"9b2c1f47-8a0d-4e21-bf3c-2d6f1a9e74c5"