Transfers

A transfer is a resource that contains information of when a user of receives a bank transfer from a merchant at the end of a transfer period. The transfer period is changeable in the merchant console settings page if you have verified your account.

A transfer covers all of the transactions that were made for a period of time.

The transfer object

Fields
idstring (UUID)
The unique identifier for the transfer
bank_account_idstring (UUID)
The id of the bank account the transfer was sent to
amountnumber
The amount of money that was transferred
currencystring (ISO-4217)
The currency of the money that was transferred
amount_formattedstring
The amount of the money that was transferred formatted to include a decimal place if there is a minor currency unit.
statusstring
The status of the transfer. One of created, approved, cancelled, pending, paid, or failed
error_codenumber
If there was an error transferring to the user’s bank account, this field will hold the code of the error
error_textstring
If there was an error transferring to the user’s bank account, this will contain a detailed message of why the error occurred.
metadatajson
Any metadata to associate with the transfer. May be
set by an admin.
fromstring (ISO-8601)
The beginning of the period of time this transfer covers
tostring (ISO-8601)
The end of the period of time this transfer covers
created_onstring (ISO-8601)
When the transfer was created.