The instructions field
When you create a transfer, the response includes an instructions field that describes what funds the customer needs to send and where. For off-ramp transfers, the depositInstructions sub-field contains the details your customer needs to initiate the on-chain transaction — the destination address, network, currency, and amount.
Transfers that are funded are executed on the next transfer execution cycle.
Transfer statuses
The table below lists every possible status a transfer can reach, in the order they typically occur.Tracking status updates
SpherePay can push transfer status updates to your systems via webhooks — subscribe to thetransfer.* events to be notified of every transition listed above. Alternatively, poll GET /v2/transfer/{id} at a reasonable interval to track progress.
Poll until the transfer reaches a terminal state:
succeeded, refunded, failed, canceled, returned, unexpectedError, or failedPrecondition. Once a transfer enters a terminal state, its status will not change.