Payment Order Status Update Callback

Payment Order Status Update

When there is a payment status change, a notification will be sent to the registered url. You may receive json payload like below.

If a notification fails, it will be retried. Once the upper limit is reached, this notification will no longer be sent, but other notifications will not be affected.

After 10 notification failures, the system will no longer send this notification. Merchant can manually reset this notification at the platform background.

Request

Field	Type	Description	Remark
noticeType	String	Notification Type	PaymentOrderStatus
bizContent	String	Encrypted Message	It needs to be decrypted by AES first and then deserialized through JSON. See PaymentNotificationData
sign	String	Signature	Sign the original bizContent and verify by RSA Public Key

PaymentNotificationData

{
  "PaymentOrderStatus": {
    "order_sn": "ABC123456789",
    "platform_order_sn": "SS2024010112121212345",
    "requestID": 10001673,
    "region": "HKG",
    "payerEmail": "[email protected]",
    "description": "Goods Payment",
    "comment": "ACCOUNTING_SERVICE",
    "requestTime": "2023-11-08 07:30:07.899+0000",
    "currency": "USD",
    "amount": 999.33,
    "linkID": "6E8BF7A8-962F-4B58-B20D-FCDE8F98CC7D",
    "linkExpiry": "2023-11-08 07:45:07.899+0000",
    "status": "New",
    "failTimes": 0,
    "creationTime": "2023-11-08 07:30:08.431+0000"
  }
}

Please refer to the table below for possible status values and their meaning.

STATUS	DESCRIPTION
New	Payment Order Created
Cancelled	Payment Order Cancelled
Processing	Payment In Progress
Paid	Payment Order Paid
Failed	Payment Fail
Expired	Payment Order Expired
RefundRequest	Raise Refund Request
RefundFailToSubmit	Fail to submit Refund Request
RefundSubmitted	Refund Request Submitted
RefundResubmitted	Refund Request Resubmitted
RefundSubmittedError	Refund Request Resubmit Error
RefundInProgress	Refund In Progress
RefundCompleted	Refund Completed
RefundFailed	Refund Fail
RefundOffsetDealFailed	Fail to create refund withdrawal deal
Chargeback	Chargeback Completed

Request Sample

{
  "noticeType": "PaymentOrderStatus",
  "bizContent": "ZXlKcGRpSTZJbTgyUzA1cmJscDZha2xVVEdkNmRVWlRiSGRsZVdjOVBTSXNJblpoYkhWbElqb2lPRzVVY1RseFEyWkNSbVF4VEVacGJpOXBVemg0UlVwdlN6Rm1lbk5tZW14U2RVOTZhRFJ3TW1GcGJ6MGlMQ0p0WVdNaU9pSTFaR1kzWWpWaE5XUTFZV05rT0Rjek9UQmpNMk15WlRBME0yUm1aV1EwTlRoaE0yUTVOekpsTkRObE16SmpORE01WkdKak9UUmhNMk5rWWpnMk4yTTNJaXdpZEdGbklqb2lJbjA9",
  "sign": "raqtzxjjWGyjrPDkn3aR+N+ZU6kpyiLeJNeFzQXmfoqsomkxsccg783FraLPWBrPgn0nhjtuVQLIWMply1chS7g1jgdGaFiGSXCwgL+XIVX0n2J1Z8YtDBEqeJLbRcmWiGAavQk8JSjBtDigJIopjL5mAT9+X5vrf4a6YxpAoky7DemuClKNb50OuH15ADICWednwQZsI0wJ8WTpZNb4f9jrMGdlztXvj/Nf7Gk2Uwx1v/morWEDe1BFD8FWFUsmKwdBxYS8iMT3f5YiAWzYt7VItOl6ymlNSdZmGazXYQ2MPScunPQXdSf2fQ6NM8NVlz7or5w5cj7aiZAgzpHUrQ=="
}

Response

The client needs to return JSON

Important：The client must use the code field in the response body to indicate the result of receiving the notification：

0：Succeeded；-1：Failed。

Field	Type	Required	Description	Remark
code	String	Y	Result Code	0Succeeded； -1：Failed
msg	String	N	Description

Response Sample

{
  "code": "0",
  "msg": "success"
}