Retrieve a Transfer with Deposit Instructions
Retrieve a specific transfer
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The payout ID.
"payout_d243ab2b1de4447d8a046d87fefe58cf"
Response
The datetime the transfer was created.
"2021-01-01T00:00:00.000Z"
The customer ID.
"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"
The deposit bank account for an on ramp transfer.
- Deposit Bank Account
- Deposit Wallet
A unique identifier for transfer.
^payout_[a-z0-9]{32}$"payout_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
The source of an on ramp transfer.
- Source Bank Account
- Source Wallet
The transfer status. See Transfer Lifecycle for status definitions and transitions.
pendingFunding, pendingReview, fundsReceived, processing, succeeded, undeliverable, returned, pendingRefundInformation, failed, canceled, refunded, unexpectedError, failedPrecondition, expired, unfunded "pendingFunding"
Timeline of status transitions for this transfer, ascending by transitionedAt.
The transfer type.
on_ramp, off_ramp, fiat_to_fiat, unmatched_deposit, microdeposit "on_ramp"
The last datetime the transfer was updated.
"2021-01-01T00:00:00.000Z"
The external reference (not stored as unique).
"merchant_ref_123"
Fee breakdown for the transfer. For floating-rate BRL transfers, this is omitted until settlement is complete.
A free-text description of the payment purpose. Present on third-party off-ramp transfers.
"INV-2026-004 - Q1 software services"
The reason for the payment. Present on BRL transfers and third-party off-ramp transfers.
"professional_services"
The quote used for this transfer, if any. When present, the locked exchange rate from the quote was applied to the destination amount and exchange rate.
Tracking references for the transfer. Only included when at least one reference exists.