Transfer API
Create a new transfer
Create a new transfer
Authorization
X-API-Key
<token>In: header
Request Body
application/json
OptionalonBehalfOf
RequiredstringThe ID of the customer that you're moving funds on behalf of
amount
RequiredstringThe source amount of the transfer
Pattern:
"^[+-]?(?:\\d*\\.)?\\d+$"
source
RequiredobjectSource of the transfer
destination
RequiredobjectDestination of the transfer
Response Body
The transfer was created successfully
id
RequiredstringThe unique ID of the transfer
state
RequiredunknownThe current state of the transfer
Value in:
"awaiting_funds" | "pending" | "completed" | "failed"
onBehalfOf
RequiredstringThe ID of the customer that you're moving funds on behalf of
amount
RequiredstringThe source amount of the transfer
Pattern:
"^[+-]?(?:\\d*\\.)?\\d+$"
source
RequiredobjectSource of the transfer
destination
RequiredobjectDestination of the transfer
sourceInstructions
objectInstructions for the source deposit (if applicable)
createdAt
RequiredstringThe date and time the transfer was created
Format:
"date-time"
updatedAt
RequiredstringThe date and time the transfer was last updated
Format:
"date-time"