Skip to main content
Advance a sandbox transfer
This endpoint works only against https://api.sandbox.spherepay.co. It moves a transfer to the given status through the same status pipeline production uses. The matching transfer.* webhook is delivered when webhooks are enabled for the application; undeliverable has no webhook event. Advancing to the current status is a no-op that returns the transfer unchanged, and a transition the lifecycle does not allow is rejected with 422.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
status
enum<string>
required

The status to advance the transfer to.

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

"succeeded"

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

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.

Example:

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

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.

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.

Example:

"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"

tracking
object

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

Last modified on November 16, 2026