Crypto Refund Request Service
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:
1. **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_STARTED` and sends a notification via webhook with the event `refund_started` to confirm the request receipt.
2. **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 event `refund_in_progress`.
3. **Sending Confirmation:**
- When the cryptocurrency sending is confirmed, the final order status will be `REFUND_DELIVERED` and a notification will be sent via webhook with the event `refund_delivered`.
**Note:**
- Multiple notifications may be received for each change in the order
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Path parameters
orderId
OrderId identifier.
Request
This endpoint expects an object.
destinationAddress
it should be the destination address for the cryptocurrencies. This attribute is crucial in ensuring that funds are sent to the correct place.
Response
successful operation
message
timestamp
code
- `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