Request a Crypto Refund
Requests the return of the crypto deposited for an off-ramp order that could not be completed (for example, because the trade could not be executed).
Check refundable on the order before calling: it tells you whether a refund can be requested right now. Whether the request must name a destination is given by refundDestinationRequired — true means refundAddress is required (unless the order already carries one from its creation), false means the crypto returns to the on-chain origin address and refundAddress is rejected.
The request is idempotent: 202 when the refund is registered, 200 when one already exists for the deposit.
Registering the refund, its approval and a rejection are all silent; only a completed refund emits an event, OFF-RAMP.ORDER.REFUNDED (see Off-Ramp Events). Follow progress — and learn of a rejection — through the latestRefund block on the order.
See Refunds for the full model.
The equivalent endpoint scoped to a customer is POST /customers/{customerId}/transactions/offramp/{orderId}/refund/.
Authorizations
Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.
Path Parameters
Unique identifier for the order.
Body
Body of a crypto refund request. Send refundAddress only when refundDestinationRequired is true and the order does not already carry one.
On-chain address the crypto is returned to. Rejected when the account is configured to refund to the deposit's origin address.
10 - 255"0x2f318C334780961FB129D2a6c30D0763d9a5C970"
Response
A refund already exists for this deposit; nothing new was created.
Acknowledgement of a crypto refund request. Follow its progress through the latestRefund block on the order.
Identifier of the off-ramp order being refunded.