Skip to main content
Retrieve a Transfer
Use este endpoint para buscar os detalhes completos de uma única transferência pelo seu ID único. A resposta inclui o status atual, os recursos de origem e destino, detalhamento de taxas, instruções de depósito para transferências on-ramp e identificadores de rastreamento a nível de rede uma vez que a transferência tenha sido processada. Consulte este endpoint ou use webhooks para monitorar transições de status ao longo do ciclo de vida da transferência.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
string
obrigatório

The payout ID.

Exemplo:

"payout_d243ab2b1de4447d8a046d87fefe58cf"

Resposta

created
string<date-time>
obrigatório

The datetime the transfer was created.

Exemplo:

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

customer
string
obrigatório

The customer ID.

Exemplo:

"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"

depositAccount
Deposit Bank Account · object
obrigatório

The deposit bank account for an on ramp transfer.

destination
Destination Wallet · object
obrigatório

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

id
string
obrigatório

A unique identifier for transfer.

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

"payout_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

source
Source Bank Account · object
obrigatório

The source of an on ramp transfer.

Exemplo:
status
enum<string>
obrigatório

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

Opções disponíveis:
pendingFunding,
pendingReview,
fundsReceived,
processing,
succeeded,
undeliverable,
returned,
pendingRefundInformation,
failed,
canceled,
refunded,
unexpectedError,
failedPrecondition,
expired,
unfunded
Exemplo:

"pendingFunding"

statusHistory
Transfer Status History Entry · object[]
obrigatório

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

Exemplo:
type
enum<string>
obrigatório

The transfer type.

Opções disponíveis:
on_ramp,
off_ramp,
fiat_to_fiat,
unmatched_deposit,
microdeposit
Exemplo:

"on_ramp"

updated
string<date-time>
obrigatório

The last datetime the transfer was updated.

Exemplo:

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

externalId
string

The external reference (not stored as unique).

Exemplo:

"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.

Exemplo:

"INV-2026-004 - Q1 software services"

paymentReason
string

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

Exemplo:

"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.

Última modificação em 22 de junho de 2026