Transfer API
Get a transfer by ID
Retrieve a transfer by ID
Authorization
X-API-Key
<token>In: header
Path Parameters
id
RequiredstringThe transfer ID
Response Body
The transfer object
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"