Refunds

This article describes the refund process for users who have made payments via W Checkout.

Refund Scenarios

User-Initiated Refund: The user actively applies for a refund after completing a normal payment order.

Overpayment: The user paid an amount exceeding the order total from their wallet.

Underpayment: The user only paid a partial amount, and the order has since timed out.

Processing Flow

1. Retrieve Abnormal Payment Scenarios

For abnormal payment scenarios such as overpayment, underpayment, and late payment, developers can obtain information via the following methods:

Webhook: Subscribe to message notifications. The system will push events related to abnormal payments.

API Query: Call the getAbnormalPayments interface to proactively query orders with abnormal payments.

2. Initiate a Refund

Call the createOrderRefund interface to initiate a refund. Tokens will be refunded via the original payment route to the specified amount based on the order's payment address.

Request Parameters

Parameter Name	Type	Required	Description
refundOrderNo	String	Yes	A unique refund order number generated by the client system to identify this refund transaction.
orderNo	String	Yes	The associated payment order number, used for order refunds.
abnormalPaymentNo	String	Yes	The associated abnormal payment number, used for refunds related to abnormal payments.
amount	Number	Yes	The amount to be refunded in this transaction.

3. Retrieve Refund Order Status

You can obtain refund progress and results through the following methods:

Webhook Notification

Subscribe to refund-related events. The system will push notifications when the refund status changes.

API Query

Call the getOrderInfo interface to query the payment order and its refund status.

Developer Notes

Original Route Refund: Refunded tokens will be returned to the wallet address the user used for the original payment.

Idempotency: It is recommended to use a unique refundOrderNo when calling the refund interface to prevent duplicate refunds.

Abnormal Payment Reconciliation: For overpayment or underpayment scenarios, it is advisable to periodically reconcile using getAbnormalPayments.

Refund Scenarios#

Processing Flow#

1. Retrieve Abnormal Payment Scenarios#

2. Initiate a Refund#

Request Parameters#

3. Retrieve Refund Order Status#