Webhook

POST

https://mock.apidog.com/m1/444561-0-default/webhook

Once the payment is complete, Bill24 will push payment data to merchant system.

NOTE
Change to your best URL: https://yourdomain/webhook
Merchant need to enable Webhook feature in Bill24 portal.

Request

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

application/json

Success

string

required

Example:

success

Body Params application/json

Parameters

tran_id

string

optional

Reference transaction at Bill24

tran_no

string

optional

Transaction number at Bill24

payment_service_type

string

optional

Transaction type
Ex: 1. Bank Channel: transaction from Bank channel (mobile app, …)
2. KHQR: transaction scan QR code pay
3. Deeplink/Checkout: transaction from checkout page or from deeplink app to app
4. Direct Debit: transaction auto direct debit

tran_date

string

optional

Transaction date

total_amount

number

optional

Original amount of the transaction

currency

string

optional

Currency code ISO 4217 (USD, KHR...)

bank_code

string

optional

Bank code at Bill24

bank_name

string

optional

Bank’s name

bank_ref

string

optional

Reference number at bank side

identity_code

string

optional

Reference number at merchant side (This code used to confirm the payment)

purpose_of_transaction

string

optional

Bill issue date or bill number

device_code

string

optional

Serial number of QR code display device or terminal

status

string

optional

Status of the transaction

customers

object

optional

List of customer data

branch_code

string

optional

Branch code

branch_name

string

optional

The name of the branch

customer_code

string

optional

Customer code

customer_name

string

optional

The name of the customer

customer_name_latin

string

optional

The name of the customer in Latin

bill_no

string

optional

Bill or invoice number

amount

number

optional

Amount of the bill or invoice

Example

{
    "tran_id": "348b4b16-1f06-4563-8204-105a8420a067",
    "tran_no": "6KOBTGwG7HSF",
    "payment_service_type": "Bank Channel",
    "tran_date": "2024-11-29T16:58:16.727168",
    "tran_amount": 45,
    "currency": "USD",
    "bank_code": "AC",
    "bank_name": "ACLEDA",
    "bank_ref": "AC00112301",
    "identity_code": "37627011",
    "purpose_of_transaction": "",
    "device_code": "",
    "status": "success",
    "customers": [
        {
            "branch_code": "",
            "branch_name": "",
            "customer_code": "37627011",
            "customer_name": "MAO SAMON",
            "customer_name_latin": "",
            "bill_no": "",
            "amount": 45
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/444561-0-default/webhook' \
--header 'Accept: application/json' \
--header 'Success: success' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tran_id": "348b4b16-1f06-4563-8204-105a8420a067",
    "tran_no": "6KOBTGwG7HSF",
    "payment_service_type": "Bank Channel",
    "tran_date": "2024-11-29T16:58:16.727168",
    "tran_amount": 45,
    "currency": "USD",
    "bank_code": "AC",
    "bank_name": "ACLEDA",
    "bank_ref": "AC00112301",
    "identity_code": "37627011",
    "purpose_of_transaction": "",
    "device_code": "",
    "status": "success",
    "customers": [
        {
            "branch_code": "",
            "branch_name": "",
            "customer_code": "37627011",
            "customer_name": "MAO SAMON",
            "customer_name_latin": "",
            "bill_no": "",
            "amount": 45
        }
    ]
}'

Responses

🟢200Success

application/json

Body

status

string

required

message

string

required

Examples

SuccessError

{
    "status": "Success",
    "message": "SUCCESS"
}

Modified at 2025-03-06 11:12:40

Transaction Verification