Pular para o conteúdo principal
Advance a sandbox transfer
Este endpoint funciona apenas em https://api.sandbox.spherepay.co. Ele move uma transferência para o status informado pelo mesmo pipeline de status usado em produção. O webhook transfer.* correspondente é entregue quando os webhooks estão habilitados para a aplicação; undeliverable não tem evento de webhook. Avançar para o status atual não faz nada e retorna a transferência sem alterações, e uma transição que o ciclo de vida não permite é rejeitada com 422.

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

Corpo

application/json
status
enum<string>
obrigatório

The status to advance the transfer to.

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

"succeeded"

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,
processingRefund,
refundFailed,
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.

fundingDeadline
string<date-time>

The datetime by which the deposit must arrive into the deposit account. A later deposit is not applied to this transfer. Present only on bank-funded transfers that have a deadline. Distinct from quote.expiresAt, which is the expiry of the quoted rate.

Exemplo:

"2026-11-03T12:00:00.000Z"

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.

returnAddress
string

Crypto wallet address where funds are sent if the transfer fails or is refunded. Only present on off-ramp transfers created with a custom return address.

Exemplo:

"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"

tracking
object

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

Última modificação em 16 de novembro de 2026