# 6. Checkout Payment Notification
# Description
This interface is implemented by the merchant. Its purpose is to notify the merchant of the repayment transaction details when the user completes a repayment transaction.
# HTTP Request Information
# URL
Provided by the merchant
# Request Method
POST
# Content-Type
application/json
# Request Body Parameters
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| param | Yes | string | Parameter Body |
| sign | Yes | string | Signature |
# param Parameters
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| eventName | Yes | string | Event name (checkout.payment.success) |
| checkoutId | Yes | string | Checkout order ID |
| countryCode | Yes | string | Country code (PH, ID, MY, TH) |
| currency | Yes | string | Pricing currency (PHP, IDR, MYR, THB) |
| settlementCurrency | Yes | string | Settlement currency (PHP, IDR, MYR, THB) |
| mchOrderId | Yes | string | Merchant order ID |
| transactionId | Yes | string | Platform transaction ID |
| amount | Yes | integer | Payment amount |
| transactionStatus | Yes | string | Transaction status (PENDING, COMPLETED, FAILED) |
| createTime | Yes | string | Transaction creation time |
| returnTime | Yes | string | Transaction completion time |
| channelCode | Yes | string | Channel code |
| remark | Yes | string | Remark |
| failedCode | No | integer | Failed code (if applicable) |
| failedMessage | No | string | Failed message (if applicable) |
# Request Example
# Request Body
{
"sign": "V6HQvEZaLF5MSH8TcOVdqPj7fLyvdrAOPm74rW9svpclBIVPlokyiZqPXl09/yAOS8PNnganUtvRvie9MAxJwtYOkDMXxxi4gWjPl3D9L6W4fnVeC28HjhZhWrSgwlecJG6SuHM3odTHAxr5WQUuOxsYFtx+c74Ew+ZzuICCH3dA4+uzNEbDyB8QmBF94nM1LFhDId/VEMxdbj8xKJuOMiSBgwAWaFElm5YCfgmrZpU/qLnuGX2hNxQAMKY2GAw+4VpphYpHG8Xak5+PlqFWKp8mKJ9DgyphVf0ACGpcjOQp0S1V+S1HMMVU0AkW6c8n0weOMu3l6k6cPHsjEe/jSQ==",
"param": "{\"eventName\":\"checkout.payment.success\",\"checkoutId\":\"CH1789920394875113472\",\"countryCode\":\"PH\",\"currency\":\"PHP\",\"settlementCurrency\":\"PHP\",\"amount\":50000,\"channelCode\":\"PH_GCASH_URL\",\"mchOrderId\":\"Platform653350151938813\",\"createTime\":\"2023-01-01 09:38:06\",\"remark\":\"test payment\",\"returnTime\":\"2024-05-13 15:29:21\",\"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"
}