Skip to main content
POST
Request a Customer's Crypto Refund

Authorizations

Authorization
string
header
required

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

Headers

X-Ripio-User-Ip
string

Optional. The public IP address of the end user's device (IPv4 or IPv6), captured on your frontend and forwarded by your backend — never your server's own address. Used for traceability and fraud prevention. An address that is not a valid IPv4 or IPv6 discards the end-user context of the request, without failing it. See Forwarding end-user context.

Maximum string length: 45
X-Ripio-User-Agent
string

Optional. The User-Agent of the end user's browser or app, not your backend's HTTP client. Longer values are truncated to 500 characters. See Forwarding end-user context.

Maximum string length: 500
X-Ripio-User-Device-Id
string

Optional. A stable identifier of the end user's device, as your app or frontend defines it. Longer values are truncated to 200 characters. See Forwarding end-user context.

Maximum string length: 200

Path Parameters

customerId
string<uuid>
required

Unique identifier for the customer.

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.