Skip to main content
Retrieve a Transfer
Use this endpoint to fetch the complete details of a single transfer by its unique ID. The response includes the current status, the source and destination resources, fee breakdown, deposit instructions for on-ramp transfers, and network-level tracking identifiers once the transfer has been processed. Poll this endpoint or use webhooks to monitor status transitions throughout the transfer lifecycle.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The payout ID.

Example:

"payout_d243ab2b1de4447d8a046d87fefe58cf"

Response

created
string<date-time>
required

The datetime the transfer was created.

Example:

"2021-01-01T00:00:00.000Z"

customer
string
required

The customer ID.

Example:

"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"

depositAccount
Deposit Bank Account · object
required

The deposit bank account for an on ramp transfer.

destination
Destination Wallet · object
required

The destination of an On-ramp transfer. See Wallets for registration.

id
string
required

A unique identifier for transfer.

Pattern: ^payout_[a-z0-9]{32}$
Example:

"payout_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

source
Source Bank Account · object
required

The source of an on ramp transfer.

Example:
status
enum<string>
required

The transfer status. See Transfer Lifecycle for status definitions and transitions.

Available options:
pendingFunding,
pendingReview,
fundsReceived,
processing,
succeeded,
undeliverable,
returned,
pendingRefundInformation,
failed,
canceled,
refunded,
unexpectedError,
failedPrecondition,
expired,
unfunded
Example:

"pendingFunding"

statusHistory
Transfer Status History Entry · object[]
required

Timeline of status transitions for this transfer, ascending by transitionedAt.

Example:
type
enum<string>
required

The transfer type.

Available options:
on_ramp,
off_ramp,
fiat_to_fiat,
unmatched_deposit,
microdeposit
Example:

"on_ramp"

updated
string<date-time>
required

The last datetime the transfer was updated.

Example:

"2021-01-01T00:00:00.000Z"

externalId
string

The external reference (not stored as unique).

Example:

"merchant_ref_123"

fees
object

Fee breakdown for the transfer. For floating-rate BRL transfers, this is omitted until settlement is complete.

paymentDescription
string

A free-text description of the payment purpose. Present on third-party off-ramp transfers.

Example:

"INV-2026-004 - Q1 software services"

paymentReason
string

The reason for the payment. Present on BRL transfers and third-party off-ramp transfers.

Example:

"professional_services"

quote
object

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
object

Tracking references for the transfer. Only included when at least one reference exists.

Last modified on June 18, 2026