When the payment order is finished, the merchant can refund this order. First, create a merchant refund order, then use this order to create a payment refund order.

Request

Request payload

POST /payment/api/v1/payment-order/refund/query HTTP/1.1
Content-Type: application/json
{
    "merchantId": "string",
    "method": "string",
    "format": "string",
    "charset": "string",
    "encryptType": "string",
    "signType": "string",
    "sign": "string",
    "timestamp": "Number",
    "body": "<encrypted body string>" // the encrypted body string
    
    //the body data structure as below
    //{
    //    "refundId": "string",
    //}
}

Please follow the Request Payload to construct the request payload.

Set the method parameter to bieases.trade.query.
Set to body parameter to Body object.

Body object

The body parameter object in the Request Payload .

Key	Type	Mandatory?	Length	Description	Example
refundId	String	Yes	32	The payment order number regarding the payment request	01J143NWJFNGBVasdfs2YB9ZRB9T7PS

Response

Response payload

200 OK
Content-Type: "application/json"

{
    "code": "string",
    "msg": "string",
    "data": 
    {
       "merchantId":"string",
       "refundId":"string",
       "paymentId":"string",
       "referRefundNo":"string",
       "refundAmount":"string",
       "completeTime":"string",
       "refundTime":"string",
       "status":"string",
       "msg":"string",
    }
}

The request will return an HTTP status code 200 if successful, with details included in the data object of the response payload.

Data object defined as below

📘
Note
The response is returned synchronously and does not require signature verification and decryption.

Data object

Key	Type	Description	Example
merchantId	String	The merchant wallet ID which can be found in the merchant wallet: Home->Merchant Information->BIEASES ID	B131567545069
refundId	String	The refund number for the payment	2013112111001004500000675973
paymentId	String	The payment order number regarding the payment request	01J143NWJFNGBV2YB9ZRB9T7PS
referRefundNo	String	The refund order number sent in the request from the merchant's platform	2013112111001004500000675971
transactionId	String	The transaction ID	8zzsLUsjPaJBDQMM86bVh2ou7f6y8W
refundAmount	Number	Refund amount. • An integer for currencies like JPY that are not typically fractional. • A decimal fraction for currencies like TND that are subdivided into thousandths.	21.55
completeTime	Timestamp	Finished refund time. It's a timestamp.	1706585572074
refundTime	Timestamp	The refund creation time. It's a timestamp	1706585572074
status	String	Please refer to Payment Order Status.
msg	String	The description of the payment order status.