transfer.completed and transfer.failed for outcomes instead of polling. Each participating account can subscribe to these events. transfer.created is also emitted on success, not when processing starts. A failed transfer can be retried under the same ID and later succeed; retrieve the transfer to reconcile its current status.
A successful balance transfer credits the recipient’s available balance unless a release date applies. Transfers funded from pending balance retain a release date and credit pending balance; applicable recipient reserves or fraud holds can keep funds unavailable. succeeded confirms the transfer completed, not that all funds are withdrawable.
Endpoints
Attributes
string
required
Transfer ID.
object | null
required
Amount credited to the recipient. Null while the transfer has not succeeded.
Properties
Properties
string
required
The amount in major units, as an exact decimal string —
"10.00" is ten
dollars. A string so no float rounds it in transit.string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — the precision the charge itself
runs at.
integer
required
How many decimal places to SHOW. Usually equal to
decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.string
required
When the transfer was created.
object | null
required
Business account or user receiving the transfer.
string | null
required
Recorded failure time. Null unless the transfer has failed.
string | null
required
Machine-readable failure code. Null unless the transfer has failed.
string | null
required
Failure explanation. Null unless the transfer has failed.
object | null
required
All applicable transfer fees, including platform markup. Null when the authoritative total is unavailable.
Properties
Properties
string
required
The amount in major units, as an exact decimal string —
"10.00" is ten
dollars. A string so no float rounds it in transit.string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — the precision the charge itself
runs at.
integer
required
How many decimal places to SHOW. Usually equal to
decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.object
required
Custom metadata attached to the transfer.
string | null
required
Transfer note.
string
required
The object type.
object | null
required
Business account or user sending the transfer.
string
required
Current transfer status. A transfer can be created
processing and settle a few seconds later; poll Retrieve Transfer or listen for the transfer.completed and transfer.failed webhooks instead of treating the create response as final. succeeded and failed are final.Available options: processing, succeeded, failedstring | null
required
Recorded time of the current transition. Null when the historical transition
time is unknown.
string | null
required
Recorded success time. Null when unknown.
string
required
Tracking page for the transfer. Viewing it requires sign-in and access to the
transfer.
Transfer