POST
/api/v2/transfers/crypto-refundsCreate a crypto refund
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (query) | unknown | No | User ID |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| TransferId | string | Yes | |
| Address | string | Yes |
Responses
201 — Created
| Field | Type | Required | Description |
|---|---|---|---|
| Success | boolean | No | |
| RefundId | string | No | |
| TransferId | string | No | |
| AccountId | string | No | |
| Destination | TransferEndpointInfo | No | Transfer endpoint information (source or destination) |
| Amount | AmountInfo | No | Amount information |
| Fees | array of FeeInfo | No | |
| Status | string | No | |
| ReferenceId | string | No | |
| CreateTime | string (date-time) | No | |
| CompleteTime | string (date-time) | No | |
| Message | string | No |
400 — Bad Request
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
401 — Unauthorized
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
404 — Not Found
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X POST "https://{base_url}/api/v2/transfers/crypto-refunds" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"TransferId":"…","Address":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.