Introduction

It is recommended that merchants verify if an order is eligible for a refund before processing it to avoid duplicate refunds or orders in non-refundable statuses (e.g., payment processing). If the status does not support a refund, an error code will be returned. See the Return Code List for details.

Refunds are supported for all tokens and networks used in payments.

API Description

Request Method: POST

Request URL: open/api/payment/checkRefund

Body Parameters

Parameter	Signature Required	Required	Type	Length	Description
`appId`	Yes	Yes	string	64	Application ID
`merchantOrderNo`	Yes	Yes	string	64	Merchant order number
`refundToken`	Yes	Yes	string	32	Refund token
`refundNetwork`	Yes	Yes	string	32	Refund network
`refundAmount`	No	No	string	32	Refund amount
`sign`	No	Yes	string	128	Signature

Example Response

Response Parameters

Parameter	Type	Length	Description
`orderNum`	string	32	ACH order number
`paymentStatus`	string	32	Payment status
`refundOrderAmount`	string	32	Refund order amount
`orderCurrency`	string	32	Order currency
`withdrawLimit`	string	32	Maximum and minimum refund limit

Response Example (JSON)

{
    "code": "0",
    "msg": "success",
    "model": {
        "orderNum": "300217186928983690133",
        "paymentStatus": "COMPLETED",
        "refundOrderAmount": 0.003833,
        "orderCurrency": "ETH",
        "withdrawLimit": "0.001149ETH~3833180.006133ETH"
    },
    "traceId": "670f7752c765235990e9accc36c44fa8",
    "success": true,
    "error": false
}