BIEASES payment system requires merchants to create the payment order before the payment checkout. Once the payment order is created, BIEASES will return with the payment order information.

The merchant platform should redirect to the checkout page to let the consumer complete the payment.

Request

Request payload

POST  /payment/api/v1/payment-order 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
    // { 
    //     "order": {
    //         "orderNo": "string",
    //         "orderAmount": "Number",
    //         "orderDescription": "string",
    //         "goods": [{
    //             "referenceGoodsId": "string",
    //             "goodsName": "string",
    //             "goodsDesc": "string",
    //             "goodsUnitAmount": "Number",
    //             "goodsQuantity": "Number"
    //         }]
    //    },
    //    "channel": "string",
    //    "paymentAmount": "string",
    //    "currency": "string",
    //    "paymentTime": "Timestamp",
    //    "paymentExpiryTime": "Timestamp",
    //    "callbackUrl": "string",
    //    "redirectUrl": "string"
    // }
}

Please refer to Request Payload for more information regarding the payload JSON.

• Set the method parameter to bieases.trade.create.
• Set to body parameter to Body object.

Body object

The body parameter object in the Request Payload .

Order object

Goods object

Shipping_ object

Response

Response payload

200 OK
Content-Type: "application/json"

{
    "code": "20000",
    "msg": "SUCCESS",
    "data": 
    {
       "paymentId":"",
       "referOrderNo":"",
       "channel":"",
       "checkoutUrl":"",
       "status":"",
    }
}

The request will be returned with HTTP status code 200 if success and details included in the data object of the response payload.

• data object defined as below

📘

Note

The response is returned synchronous and does not require signature verification and decryption.

Data object

Examples

Follow the steps below to construct the payment request message.

1. Construct the request object.

   Request Object

   {
       "merchantId": "B131567545069",
       "method": "bieases.trade.create",
       "format": "json",
       "charset": "utf-8",
       "encryptType": "AES",
       "signType": "RSA",
       "timestamp": 1706585572074,
       "body": { 
           "order": {
               "orderNo": "111111111111111",
               "orderAmount": "10.0",
               "orderDescription": "",
               "goods": [{
                   "referenceGoodsId": "213111131",
                   "goodsName": "fans",
                   "goodsDesc": "",
                   "goodsUnitAmount": "1",
                   "goodsQuantity": "3"
               }]
          },
          "channel": "Web",
          "paymentAmount": "100.0",
          "currency": "USD",
          "paymentTime": "7065855724",
          "paymentExpiryTime": "7065856724",
          "callbackUrl": "https://merchantserverhost/pay/complete/callback/url",
          "redirectUrl": "https://merchantserverhost/pay/complete/redirect/url"
      }
   }
   

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

   Request Object

   {
       "merchantId": "B131567545069",
       "method": "bieases.trade.create",
       "format": "json",
       "charset": "utf-8",
       "encryptType": "AES",
       "signType": "RSA",
   	   
       // Add the signature to the request parameter
       "sign": "hcsZg0q6sLm4gRQ97MBAlkNFAJCFXUAlnxlJCzjjwNwJJ9i8JIXoFjnzi6zRpyt6Vw7RGiUvUsLCq6PSUEIQ4B45ZaOCZCcs8SqCEP/ybxyacOnOD5Km8y7XbOJGYFgvepixo4BvigTvfrPydjtbeJMxoaRJnsvhgAtcwxErLwM3GARLMP4sEj/5xEheO1zvmD1BoacEBBxcE5uGXm0YSLE45NDeNvwVYPg9mJYmsVzHT7+NQngFFTHpPOoN5YaD+iI6PeU+h6r3ulq4+rDgjTc+3451Ce7g32ZXBRwOS3osAU9BBiW1bL97J4vXBhdBiL9iiEbE3BdbHlf03HPpIg==",
   
       "timestamp": 1706585572074,
       "body": { 
           "order": {
               "orderNo": "111111111111111",
               "orderAmount": "10.0",
               "orderDescription": "",
               "goods": [{
                   "referenceGoodsId": "213111131",
                   "goodsName": "fans",
                   "goodsDesc": "",
                   "goodsUnitAmount": "1",
                   "goodsQuantity": "3"
               }]
          },
          "channel": "Web",
          "paymentAmount": "100.0",
          "currency": "USD",
          "paymentTime": "7065855724",
          "paymentExpiryTime": "7065856724",
          "callbackUrl": "https://merchantserverhost/pay/complete/callback/url",
          "redirectUrl": "https://merchantserverhost/pay/complete/redirect/url"
      }
   }
   

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

   Java

   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");
   //for example: "7K2AyShlt1fOrKhCTC42EpqOnXxzSAiY+pLWGLo2AX4Q7uWjcv6SNQFUpgUpzrvRVXb4wQtTtdAelRk8YnqBGl/UlUR08cSWz4VALGT+YJB7FUEMfZ7m8Y3kLloe8Mv4Kg4D8uNNBmIUUZBPS782tQVoSNG+B0jLjqISTltY5UkqkidQnbPKxXO0XeFJApW00UZIJhuhUhaQgMT3/cmO5XzDtVjOa2FRszMi65zoeWyoFVXYxqJwiZ4PVv7FFRzoDbcbtXL1mJ/TeJ51UC2zdeJN9IW41aw6e2dE3xx++PLsLbzhtwJg/qra/+4/94kQw/gB3qWGbeb9icOC/A7TnFqOWkct7A9xYlm1mYbyBer1EYpNSZ/IB156ou+YS4S3aeqtDoXp+wRk0L9fYZher5cwy7GD2IPGMF9OLDd+5/ml7Lpik9dOmu9m8UljJLNM620o3j7R3clFB1Zztrd53i78/K/XOgj0Kd+rJt1CUkcAjFleTXDP63uFMcbFz36iHv6+/tPfisGGCX98jEGVWA=="
   

4. Replace the body parameter with the encrypted value.

   Request Object

   {
       "merchantId": "B131567545069",
       "method": "bieases.trade.create",
       "format": "json",
       "charset": "utf-8",
       "encryptType": "AES",
       "signType": "RSA",
     	
        // Add the signature to the request parameter
       "sign": "hcsZg0q6sLm4gRQ97MBAlkNFAJCFXUAlnxlJCzjjwNwJJ9i8JIXoFjnzi6zRpyt6Vw7RGiUvUsLCq6PSUEIQ4B45ZaOCZCcs8SqCEP/ybxyacOnOD5Km8y7XbOJGYFgvepixo4BvigTvfrPydjtbeJMxoaRJnsvhgAtcwxErLwM3GARLMP4sEj/5xEheO1zvmD1BoacEBBxcE5uGXm0YSLE45NDeNvwVYPg9mJYmsVzHT7+NQngFFTHpPOoN5YaD+iI6PeU+h6r3ulq4+rDgjTc+3451Ce7g32ZXBRwOS3osAU9BBiW1bL97J4vXBhdBiL9iiEbE3BdbHlf03HPpIg==",
   
       "timestamp": 1706585572074,
   
       // Encrypted payment object
       "body": "7K2AyShlt1fOrKhCTC42EpqOnXxzSAiY+pLWGLo2AX4Q7uWjcv6SNQFUpgUpzrvRVXb4wQtTtdAelRk8YnqBGl/UlUR08cSWz4VALGT+YJB7FUEMfZ7m8Y3kLloe8Mv4Kg4D8uNNBmIUUZBPS782tQVoSNG+B0jLjqISTltY5UkqkidQnbPKxXO0XeFJApW00UZIJhuhUhaQgMT3/cmO5XzDtVjOa2FRszMi65zoeWyoFVXYxqJwiZ4PVv7FFRzoDbcbtXL1mJ/TeJ51UC2zdeJN9IW41aw6e2dE3xx++PLsLbzhtwJg/qra/+4/94kQw/gB3qWGbeb9icOC/A7TnFqOWkct7A9xYlm1mYbyBer1EYpNSZ/IB156ou+YS4S3aeqtDoXp+wRk0L9fYZher5cwy7GD2IPGMF9OLDd+5/ml7Lpik9dOmu9m8UljJLNM620o3j7R3clFB1Zztrd53i78/K/XOgj0Kd+rJt1CUkcAjFleTXDP63uFMcbFz36iHv6+/tPfisGGCX98jEGVWA=="
   }
   
   

   
   

5. Send the request to the BIEASES payment gateway.

   HTTPS

   POST /payment/api/v1/payment-order HTTP 1.1
   Content-Type: "application/json"
   
   {
       "merchantId": "B131567545069",
       "method": "bieases.trade.create",
       "format": "json",
       "charset": "UTF-8",
       "encryptType": "AES",
       "signType": "RSA",
       "sign": "hcsZg0q6sLm4gRQ97MBAlkNFAJCFXUAlnxlJCzjjwNwJJ9i8JIXoFjnzi6zRpyt6Vw7RGiUvUsLCq6PSUEIQ4B45ZaOCZCcs8SqCEP/ybxyacOnOD5Km8y7XbOJGYFgvepixo4BvigTvfrPydjtbeJMxoaRJnsvhgAtcwxErLwM3GARLMP4sEj/5xEheO1zvmD1BoacEBBxcE5uGXm0YSLE45NDeNvwVYPg9mJYmsVzHT7+NQngFFTHpPOoN5YaD+iI6PeU+h6r3ulq4+rDgjTc+3451Ce7g32ZXBRwOS3osAU9BBiW1bL97J4vXBhdBiL9iiEbE3BdbHlf03HPpIg==",
       "timestamp": "1706585572074",
       "body": "7K2AyShlt1fOrKhCTC42EpqOnXxzSAiY+pLWGLo2AX4Q7uWjcv6SNQFUpgUpzrvRVXb4wQtTtdAelRk8YnqBGl/UlUR08cSWz4VALGT+YJB7FUEMfZ7m8Y3kLloe8Mv4Kg4D8uNNBmIUUZBPS782tQVoSNG+B0jLjqISTltY5UkqkidQnbPKxXO0XeFJApW00UZIJhuhUhaQgMT3/cmO5XzDtVjOa2FRszMi65zoeWyoFVXYxqJwiZ4PVv7FFRzoDbcbtXL1mJ/TeJ51UC2zdeJN9IW41aw6e2dE3xx++PLsLbzhtwJg/qra/+4/94kQw/gB3qWGbeb9icOC/A7TnFqOWkct7A9xYlm1mYbyBer1EYpNSZ/IB156ou+YS4S3aeqtDoXp+wRk0L9fYZher5cwy7GD2IPGMF9OLDd+5/ml7Lpik9dOmu9m8UljJLNM620o3j7R3clFB1Zztrd53i78/K/XOgj0Kd+rJt1CUkcAjFleTXDP63uFMcbFz36iHv6+/tPfisGGCX98jEGVWA=="
   }
   

6. The following JSON shows an example of the Create Payment request being returned when you requested.

   Response

   200 OK
   Content-Type: "application/json"
   
   {
       "code": "20000",
       "msg": "SUCCESS",
       "data": 
       {
          "paymentId":"",
          "referOrderNo":"",
          "channel":"",
          "checkoutUrl":"",
          "status":"",
       }
   }
   

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