7. Direct Debit Notification

Descrption

• This interface should be implemented by merchant. The function is that when a direct debit transaction has been completed, Platform will call this interface to notify the merchant of the transaction details.

URL

• Provided by merchant.

Method

• POST

Request Header

Parameter name	Required	Type of data	Description
Content-Type	Y	string	application/json

Request Body

Parameter Name	Required	Type	Description
param	Yes	string	param
sign	Yes	string	signature

param

Parameter name	Required	Type of data	Description
eventName	Yes	string	Event name（ direct.debit.success ， direct.debit.failed ）
mchOrderId	Yes	string	Merchant order ID, alphanumeric, max length 32
transactionId	Yes	string	Platform transaction ID
amount	Yes	long	Payment amount (Unit is in cents)
transactionStatus	Yes	string	Transaction status（PENDING , COMPLETED, FAILED）
createTime	Yes	string	Payment create time
returnTime	Yes	string	Payment finish time
channelCode	Yes	string	Channel Code
remark	Yes	string	Remark
failedCode	No	integer	Failed Code
failedMessage	No	string	Failed Message

Request Example

Request Body

{
  "sign": "V6HQvEZaLF5MSH8TcOVdqPj7fLyvdrAOPm74rW9svpclBIVPlokyiZqPXl09/yAOS8PNnganUtvRvie9MAxJwtYOkDMXxxi4gWjPl3D9L6W4fnVeC28HjhZhWrSgwlecJG6SuHM3odTHAxr5WQUuOxsYFtx+c74Ew+ZzuICCH3dA4+uzNEbDyB8QmBF94nM1LFhDId/VEMxdbj8xKJuOMiSBgwAWaFElm5YCfgmrZpU/qLnuGX2hNxQAMKY2GAw+4VpphYpHG8Xak5+PlqFWKp8mKJ9DgyphVf0ACGpcjOQp0S1V+S1HMMVU0AkW6c8n0weOMu3l6k6cPHsjEe/jSQ==",
  "param": "{\"eventName\":\"direct.debit.success\",\"amount\":50000,\"channelCode\":\"BLUEPAY_DIRECT_DEBIT\",\"mchOrderId\":\"Platform653350151938813\",\"createTime\":\"2024-07-09T15:37:52+08:00\",\"remark\":\"test payment\",\"returnTime\":\"2024-07-09T16:20:23+08:00\",\"transactionId\":\"CU4Y9920490660433920\",\"transactionStatus\":\"COMPLETED\"}"
}

How to construct request body for Platform

---

Response Parameters

Parameter Name	Type	Description
code	integer	Response code, fixed as 10000
message	string	Response message, fixed as Success

Response Example

{
    "code": 10000,
    "message": "Success"
}