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_STARTED and sends a notification via webhook with the event refund_started to confirm the request receipt.
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.
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

POST

orders

offramp

{orderId}

refund

curl --request POST \
  --url https://api-sandbox.koywe.com/rest/orders/offramp/{orderId}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "destinationAddress": "0x40f9bf922c23c43acdad71Ab4425280C0ffBD697"
}'

{
  "message": "ok",
  "timestamp": "2024-06-24T17:27:48.585Z",
  "code": "REFUND_000",
  "data": {
    "orderId": "b3b6d577-1be4-4845-9d5b-b43fdef1920a"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orderId

string

required

OrderId identifier.

Body

application/json

destinationAddress

string

required

it should be the destination address for the cryptocurrencies. This attribute is crucial in ensuring that funds are sent to the correct place.

Example:

"0x40f9bf922c23c43acdad71Ab4425280C0ffBD697"

Response

200

application/json

successful operation

message

string

Example:

"ok"

timestamp

string

Example:

"2024-06-24T17:27:48.585Z"

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.

Example:

"REFUND_000"

data

object

Retrieve order information by txHash Add txHash to off ramp order

curl --request POST \
  --url https://api-sandbox.koywe.com/rest/orders/offramp/{orderId}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "destinationAddress": "0x40f9bf922c23c43acdad71Ab4425280C0ffBD697"
}'

{
  "message": "ok",
  "timestamp": "2024-06-24T17:27:48.585Z",
  "code": "REFUND_000",
  "data": {
    "orderId": "b3b6d577-1be4-4845-9d5b-b43fdef1920a"
  }
}

Introduction

About Koywe

Documentation

API Documentation

Order refund

Authorizations

Path Parameters

Body

Response