Refund an off-ramp
Refunds a failed off-ramp payment. Choose how the funds are returned:
credit: Return the funds to the user’s Spritz balance.account: Reissue the payout to a bank account — passaccountId, or omit it to reuse the original destination account.
Only failed Modern Treasury and Checkbook off-ramps can be refunded.
Recommended: send an Idempotency-Key header (a unique key per refund, reused verbatim on retries) so a timed-out request that is retried replays the original response instead of returning a stale “not refundable” error.
Authorizations
Cognito JWT token for regular user authentication
Path Parameters
The off-ramp ID
"6a749a054c3b8fc5da595d21"
Body
How to refund the off-ramp.
credit: Return the funds to the user's Spritz balance.account: Reissue the payout to a bank account (accountId, or the original account if omitted).
- Option 1
- Option 2
How to refund the off-ramp.
credit: Return the funds to the user's Spritz balance.account: Reissue the payout to a bank account (accountId, or the original account if omitted).
Return the funds to the user's Spritz balance as credit.
credit Response
Response for status 200
Unique off-ramp identifier
"offramp_xyz789"
awaiting_funding, queued, in_flight, completed, canceled, failed, reversed, refunded When the off-ramp was completed. Null until status is completed.
What the user paid — crypto asset and chain.
What the destination receives — fiat delivery details.
Type of fiat destination.
bank_account: Bank account (includes debit card destinations).bill: Bill payment.crypto_card: Crypto card deposit.
bank_account "bank_account"