Once the payment order is created, the merchant can use the paymentId to retrieve the payment order status and information, in case of network issues preventing the callback from being received.

Request

Request payload

POST /payment/api/v1/payment-order/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
    // { 
    //     "paymentId": "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
paymentId	String	Yes	32	The payment order number regarding the payment request	01J143NWJFNGBV2YB9ZRB9T7PS

Response

Response payload

200 OK
Content-Type: "application/json"

{
    "code": "string",
    "msg": "string",
    "data": 
    {
       "merchantId":"string",
       "referOrderNo":"string",
       "payAmount":"string",
       "currency":"string",
       "currency":"string",
       "paymentTime":"string",
       "paidTime":"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	Length	Description	Example
status	String	*	Please refer to Payment Order Status for more information.
transactionId	String	30	The wallet transaction ID
msg	String	*	If payment fails, this will return a reason	order has timed out
merchantId	String	18	The merchant ID.	B131567545069
referOrderNo	String	32	The refund order number or the original order number from the merchant's platform. If there is no refund order number, please put the original order number.	2013112111001004500000675971
payAmount	Number	*	The actual payment amount. • An integer for currencies like JPY that are not typically fractional. • A decimal fraction for currencies like TND that are subdivided into thousandths.	25.99
currency	String	*	Currency code. Refer to ISO 4217	USD
paymentTime	Timestamp	*	The timestamp of payment time	1706585572074
paidTime	Timestamp	*	The timestamp of the payment time	1706585572074

Examples

Follow the steps below to construct the payment request message.

Construct the request object.

{
    "merchantId": "B131567545069",
    "method": "bieases.trade.query",
    "format": "json",
    "charset": "utf-8",
    "encryptType": "AES",
    "signType": "RSA",
    "timestamp": 1706585572074,
    "body": { 
              "paymentId": "1754349465357123584",
            }
}

Sign the request and add the signature to the request body.

{
    "merchantId": "B131567545069",
    "method": "bieases.trade.query",
    "format": "json",
    "charset": "utf-8",
    "encryptType": "AES",
    "signType": "RSA",
	   
    // Add the signature to the request parameter
    "sign": "<signature string>",

    "timestamp": 1706585572074,
    "body": { 
              "paymentId": "1754349465357123584",
            }
}

Encrypt the Payment Object
Refer to the Request Sandbox Access or Request production secure keys to get your AES encrypt key.

String body ="{Payment Object JSON String}";// The payment object JSON string which is constructed in step 1.

//encrypt the body with the given AES encrypt key from BIEASES.
String encryptedBody = AesEncrypt.encrypt(body, aesEncryptKey, "UTF-8");

//  "7K2Ay...VWA=="

Replace the body parameter with the encrypted value.

{
    "merchantId": "B131567545069",
    "method": "bieases.trade.query",
    "format": "json",
    "charset": "utf-8",
    "encryptType": "AES",
    "signType": "RSA",
  	
     // Add the signature to the request parameter
    "sign": "<signature string>",

    "timestamp": 1706585572074,

    // Encrypted payment object
    "body": "<encrypted data body>"
}

Send the request to the BIEASES payment API.

POST /api/v1/gateway HTTP 1.1
Content-Type: "application/json"

{
    "merchantId": "B131567545069",
    "method": "bieases.trade.query",
    "format": "json",
    "charset": "utf-8",
    "encryptType": "AES",
    "signType": "RSA",
    "sign": "<signature string>",
    "timestamp": 1706585572074,
    "body": "<encrypted data body>"
}

The following JSON shows an example of the Query Payment response being returned when you requested it.

200 OK
Content-Type: "application/json"

{
    "code": "string",
    "msg": "string",
    "data": 
    {
       "merchantId":"string",
       "referOrderNo":"string",
       "payAmount":"string",
       "currency":"string",
       "currency":"string",
       "paymentTime":"string",
       "paidTime":"string",
       "status":"string",
       "msg":"string",
    }
}

Verify the signature and decrypt The body to hand the response as your logic.