# 3. Payment Notification
# Descrption
This interface should be implemented by merchant. The function is that when a payment transaction has been completed, Platform will call this interface to notify the merchant of the payment transaction details.
# HTTP request info
# URL
Provided by merchant.
# Method
POST
# Content-Type
application/json
# Request Body
Parameter Name | Required | Type | Description |
---|---|---|---|
param | Y | string | param |
sign | Y | string | signature |
# param
Parameter Name | Required | Type | Description |
---|---|---|---|
eventName | Y | string | event name( static.order.payment.success , static.order.payment.failed ) |
mchOrderId | Y | string | merchant order ID, alphanumeric, max length 32 |
transactionId | Y | string | Platform transaction ID |
amount | Y | integer | payment amount (unit: cents) PHP:500.10, callback value is 50010 cents |
transactionStatus | Y | string | transaction status(PENDING , COMPLETED , FAILED ) |
createTime | Y | string | payment create time |
returnTime | Y | string | payment finish time |
channelCode | Y | string | channel code |
remark | Y | string | remark |
failedCode | N | integer | Failed Code |
failedMessage | N | string | Failed Message |
# Request Example
# Request Body
{
"sign": "V6HQvEZaLF5MSH8TcOVdqPj7fLyvdrAOPm74rW9svpclBIVPlokyiZqPXl09/yAOS8PNnganUtvRvie9MAxJwtYOkDMXxxi4gWjPl3D9L6W4fnVeC28HjhZhWrSgwlecJG6SuHM3odTHAxr5WQUuOxsYFtx+c74Ew+ZzuICCH3dA4+uzNEbDyB8QmBF94nM1LFhDId/VEMxdbj8xKJuOMiSBgwAWaFElm5YCfgmrZpU/qLnuGX2hNxQAMKY2GAw+4VpphYpHG8Xak5+PlqFWKp8mKJ9DgyphVf0ACGpcjOQp0S1V+S1HMMVU0AkW6c8n0weOMu3l6k6cPHsjEe/jSQ==",
"param": "{\"eventName\":\"static.order.payment.success\",\"amount\":50000,\"channelCode\":\"ID_BCA_VA\",\"mchOrderId\":\"Platform653350151938813\",\"createTime\":\"2023-01-01 09:38:06\",\"remark\":\"test payment\",\"sign\":\"xxxxxxxxxxxxx\",\"returnTime\":\"2023-01-01 09:40:06\",\"transactionId\":\"C1032653961085706055\",\"transactionStatus\":\"COMPLETED\"}"
}
How Platform construct request body
# Response Param
Paramter Name | Type | Description |
---|---|---|
code | integer | Response code, fixed value 10000 |
message | string | Response message, fixed value Success |
# Response Example
{
"code": 10000,
"message": "Success"
}