POST/api/v2/transfers/crypto-refunds

Create a crypto refund

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
userId (query)unknownNoUser ID

Request body

application/json

Request body fields
FieldTypeRequiredDescription
TransferIdstringYes
AddressstringYes

Responses

201 — Created

Response 201 fields
FieldTypeRequiredDescription
SuccessbooleanNo
RefundIdstringNo
TransferIdstringNo
AccountIdstringNo
DestinationTransferEndpointInfoNoTransfer endpoint information (source or destination)
AmountAmountInfoNoAmount information
Feesarray of FeeInfoNo
StatusstringNo
ReferenceIdstringNo
CreateTimestring (date-time)No
CompleteTimestring (date-time)No
MessagestringNo

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

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.