Skip to content

Notify Payment Result (Webhook)

An endpoint that will be triggered to send the payment result of the transaction to the integrator-
defined notification URL upon boarding.

When integrator register a webhook, integrator will receive notifications on the registered URL.
This notification is standard responses wrapped in the “payload”.

To be notified with the payment result, integrator will need to prepare the endpoint that
accepts the following requirements.

POST

Request Description

HEADER PARAMETERS

Content-Type optional
string
Default content type of the API.
Authorization required
string
Unique identifier of the integrator.

REQUEST BODY SCHEMA: application/json

payload required
string
Generated JSON Web Token (JWT) from transaction data signed with integrator's secret using HS256 algorithm.
Un-sign the received payload body by using the issued integrator secret key. Verify that the token is not expired, and the signature is verified before saving or updating the status

Info

It is best practice to NOT SAVE unverified payload data.

  {
    "iss": "TLPE",
    "sub": "TLPE Notification Authentication",
    "aud": "TLPE Notification",
    "exp": 1597470128,
    "iat": 1597297328,
    "jti": "af2b18d2-0368-4570-88ac-36905ea5bca5",
    "data": {
        "customer": {
            "first_name": "John",
            "last_name": "Doe",
            "billing_address": {
                "line1": "Vicente Madrigal Building",
                "line2": "Ayala Avenue",
                "city_municipality": "Makati City",
                "zip": "1234",
                "state_province_region": "Metro Manila",
                "country_code": "PH"
            },
            "shipping_address": {
                "line1": "Vicente Madrigal Building",
                "line2": "Ayala Avenue",
                "city_municipality": "Makati City",
                "zip": "1234",
                "state_province_region": "Metro Manila",
                "country_code": "PH"
            },
            "contact": {
                "email": "johndoe@domain.com",
                "mobile": "+639123456789"
            }
        },
        "payment": {
            "description": "Payment for a product",
            "amount": "1.50",
            "currency": "PHP",
            "option": "GCash",
            "merchant_reference_id": "INV-123",
            "other_references": [
               "string", "string"
            ]
        },
        "result": {
            "statusCode": "OK.00.00",
            "message": "Payment successful",
            "timestamp": "2020-08-13 13:39:39.0"
        },
        "custom_parameters": {
                "custom_param1": "param 1",
                "custom_param2": "param 2",
                "custom_param3": "param 3
        },
        "transaction_id": "TRX-10001"
    }
  }
Custom parameters passed in transaction processing will be returned in the custom_parameters object if any.

See API Reference > Notify Status Payload Body Claims for a guided requirement.