Refund claims
Payer-facing; the claim token from the refund link is the credential
GET /v1/refund_claims/{token}
A refund offered to you (the payer).
Shows the amount, the merchant and the networks you can receive it on. The token from the claim link is the only credential.
Authentication:
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
tokenrequired | path | string | Claim token from the refund link (rcl_…) |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | RefundClaim application/json | |
| 404 | ErrorResponse application/json |
POST /v1/refund_claims/{token}
Choose where to receive the refund.
Give a network from the claim's networks and your address on it. The address is screened (the OFAC
SDN list and the token issuer's blacklist); a clear address goes to the merchant to send from their
wallet. Submitting the same network and address again is harmless; a different one after a
successful claim is refused (claim_already_submitted).
Authentication:
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
tokenrequired | path | string | Claim token from the refund link (rcl_…) |
Idempotency-Keyrequired | header | string | Unique per submission |
Request body
application/json
| Field | Type | Description |
|---|---|---|
networkrequired | string | One of the claim's
|
addressrequired | string | Your address on that network. For an exchange account, your deposit address for this asset on exactly this network. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | RefundClaim application/json | |
| 400 | Unknown network or invalid address | ErrorResponse application/json |
| 404 | ErrorResponse application/json | |
| 409 | Already claimed, sent, cancelled or expired | ErrorResponse application/json |