Skip to main content
POST
Request a Crypto Refund
Crypto refunds are an opt-in feature that must be enabled for your account by the Ripio team. While it is disabled, every request returns 403 Forbidden with the error code 20072 (CryptoRefundNotEnabledException), and refundable is always false on your orders.

Authorizations

Authorization
string
header
required

Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.

Path Parameters

orderId
string<uuid>
required

Unique identifier for the order.

Body

application/json

Body of a crypto refund request. Send refundAddress only when refundDestinationRequired is true and the order does not already carry one.

refundAddress
string

On-chain address the crypto is returned to. Rejected when the account is configured to refund to the deposit's origin address.

Required string length: 10 - 255
Example:

"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.

transactionId
string<uuid>

Identifier of the off-ramp order being refunded.