3 Checkout Callback

Request URL

• /xxx

Request Method

• POST

Request Params

parameter name	Is it mandatory	type of data	description
eventName	mandatory	string	Event Name (h5.payment.success, h5.payment.failed)
mchOrderId	mandatory	string	Merchant mchOrderId
transactionId	mandatory	string	PayCools Unique transaction number
amount	mandatory	int	Amount
transactionStatus	mandatory	string	Transaction Status: PENDING, COMPLETE, FAILED
createTime	mandatory	string	Create Time
returnTime	mandatory	string	Return Time
channelCode	mandatory	string	Used for payment callback - Channel Code
remark	optional	string	Remark
failedCode	optional	int	Failed Code
failedMessage	optional	string	Failed Message
sign	mandatory	string	sign

Callback Signature Reference Callback Signature Reference

callback example

// payment success callback
{
  "eventName": "checkout.payment.success",
  "amount": 5000,
  "channelCode": "GCASH_URL",
  "mchOrderId": "CCVA1653350151938813",
  "createTime": "2022-05-31 09:38:06",
  "returnTime": "2022-05-31 09:38:06",
  "remark": "gcash payment",
  "sign": "xxxxxxxxxxxxx",
  "returnTime": "2022-05-31 09:38:06",
  "transactionId": "C1032653961085706055",
  "transactionStatus": "COMPLETE"
}

// payment failed callback
{
  "eventName": "checkout.payment.failed",
  "amount": 5000,
  "channelCode": "GCASH_URL",
  "mchOrderId": "CCVA1653350151938813",
  "createTime": "2022-05-31 09:38:06",
  "remark": "gcash payment",
  "sign": "xxxxxxxxxxxxx",
  "returnTime": "2022-05-31 09:38:06",
  "transactionId": "C1032653961085706055",
  "transactionStatus": "FAILED"
}

Response Example

{
  "code": 1,
  "msg": "success",
  "data": {
  }
}