Settled Notification

Descrption

• This interface is implemented by the merchant, and its function is to notify the merchant of the repayment transaction details when the merchant's transaction settlement is completed. Bluepay will callback this interface.

URL

• Provided by merchant.

Method

• POST

Content-Type

application/json

Request parameters

paramter name	required	type	description
param	Yes	string	param
sign	Yes	string	sign

Request parameters

parameter name	required	type	description
eventName	Yes	string	event name（ settle.payment.success）
mchOrderId	Yes	string	mchOrderId, alphanumeric, max length 32
transactionId	Yes	string	Bluepay transaction ID
amount	integer	amount (unit: cents)	transaction amount
fee	integer	fee (unit: cents)	transaction fee
settledReturnTime	Yes	string	payment settled time
channelCode	Yes	string	channel code
projectType	No	string	projectType， 'PPCASH','VIP','HOME' (Delivery bill direct debit is NULL)
remark	Yes	string	remark

Response parameters

paramter name	type	description
code	integer	Response code, fixed value 10000
message	string	Response message, fixed value Success

Request example

Param content

{
  "channelCode": "THAI_DYNAMIC_QR",
  "eventName": "settle.payment.success",
  "mchOrderId": "8880001",
  "transactionId": "QR123456789",
  "amount": 2300,
  "fee": 0,
  "projectType": "PPCASH",
  "settledReturnTime": "2022-11-28 22:10:10",
  "remark": "example"
}

How Bluepay construct request body

Request body

{
  "sign": "V6HQvEZaLF5MSH8TcOVdqPj7fLyvdrAOPm74rW9svpclBIVPlokyiZqPXl09/yAOS8PNnganUtvRvie9MAxJwtYOkDMXxxi4gWjPl3D9L6W4fnVeC28HjhZhWrSgwlecJG6SuHM3odTHAxr5WQUuOxsYFtx+c74Ew+ZzuICCH3dA4+uzNEbDyB8QmBF94nM1LFhDId/VEMxdbj8xKJuOMiSBgwAWaFElm5YCfgmrZpU/qLnuGX2hNxQAMKY2GAw+4VpphYpHG8Xak5+PlqFWKp8mKJ9DgyphVf0ACGpcjOQp0S1V+S1HMMVU0AkW6c8n0weOMu3l6k6cPHsjEe/jSQ==",
  "param": "{\"channelCode\":\"THAI_DYNAMIC_QR\",\"mchOrderId\":\"8880001\",\"transactionId\":\"QR123456789\",\"amount\":2300,\"fee\":0,\"projectType\":\"PPCASH\"\"settledReturnTime\":\"2022-11-28 22:10:10\",\"remark\":\"example\"}"
}

Response example

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