Orders
Order refund
Orders
Order refund
This service allows users to request a refund of cryptocurrencies when off-ramp orders have errors in their fiat transfer details (status: INVALID_WITHDRAWALS_DETAIL). The refund process is managed through multiple statuses and notifications via webhooks.
Flows:
-
Refund Request:
- Endpoint:
/orders/offramp/{orderId}/refund - Description: Initiates a cryptocurrency refund request for orders with errors in their fiat transfer details.
- Result: Generates a new order status
REFUND_STARTEDand sends a notification via webhook with the eventrefund_startedto confirm the request receipt.
- Endpoint:
-
Crypto Sending Process:
- Once the process of sending cryptocurrencies begins, the status changes to
REFUND_IN_PROGRESS. A notification will be sent via webhook with the eventrefund_in_progress.
- Once the process of sending cryptocurrencies begins, the status changes to
-
Sending Confirmation:
- When the cryptocurrency sending is confirmed, the final order status will be
REFUND_DELIVEREDand a notification will be sent via webhook with the eventrefund_delivered.
- When the cryptocurrency sending is confirmed, the final order status will be
Note:
- Multiple notifications may be received for each change in the order
POST
/
orders
/
offramp
/
{orderId}
/
refund
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
orderId
string
requiredOrderId identifier.
Body
application/json
destinationAddress
string
requiredit should be the destination address for the cryptocurrencies. This attribute is crucial in ensuring that funds are sent to the correct place.
Response
200 - application/json
message
string
timestamp
string
code
string
- `REFUND_000`: Refund order successful.
- `REFUND_001`: Order not found.
- `REFUND_002`: Wrong order type.
- `REFUND_003`: Wrong order status.
- `REFUND_004`: Refund is processing.
- `REFUND_005`: Refund already requested.
- `REFUND_006`: Wrong wallet address.
- `REFUND_007`: Missing transaction wallet address.
data
object