Webhook Call

POST

/{webhook-call-url}

Webhook

We will send payment event to your application with this schema. You have to return 200 Http status response, we will send this call every minute with maximum tries of 3.

Request

Path Params

webhook-call-url

string

required

Header Params

Content-Type

string

optional

application/json

Signature

string

required

request body or query string hash value using HMAC method. algorithm=sha256, key = API_KEY

Body Params application/json

event

enum<string>

optional

Event Name

Allowed values:

payment.receivedpayment.reversal

context

object (Bill)

optional

Bill model

Example:

{"invoice_number":"INV-001","type":"close","va_number":"0090011234567890","name":"SPP Maret 2022","customer_name":"John Doe","customer_email":"string","customer_phone":null,"customer_address":"Surabaya, ID","total_amount":100000,"billed_amount":100000,"paid_amount":0,"description":null,"ext_description":null,"due_date":"2022-04-12T11:22:52+07:00","valid_until":"2022-04-12T11:22:52+07:00","status":"active","created_at":"2022-04-12T11:22:52+07:00","hash":"string"}

invoice_number

string

optional

Example:

INV-001

type

enum<string>

optional

Allowed values:

openclosepartial

Example:

va_number

string

optional

16 Digit Virtual account number that is billed, provided that the first 6 digits according to the prefix code depending on the payment channel, and the last 10 digits according to your request.

Example:

0090011234567890

name

string

optional

Example:

SPP Maret 2022

customer_name

string

optional

Example:

John Doe

customer_email

string | null

optional

customer_phone

null | string

optional

customer_address

string | null

optional

Example:

Surabaya, ID

total_amount

number

optional

Example:

100000

billed_amount

number

optional

Example:

100000

paid_amount

number

optional

Default:

Example:

description

string | null

optional

ext_description

string | null

optional

due_date

string | null

optional

Bill due time in ISO 8601 format

Example:

2022-04-05T13:25:41+07:00

valid_until

string | null

optional

Bill valid time in ISO 8601 format

Example:

2022-04-05T13:25:41+07:00

status

enum<string>

optional

Allowed values:

paidvoidreversalactiveexpired

Default:

active

Example:

active

created_at

string

optional

Bill created time in ISO8601 format

Example:

2022-04-12T11:22:52+07:00

hash

string

optional

>= 1 characters

components

array[object (Bill-components) {5}]

optional

payload

object (Payment Schema)

optional

Payment schema model.

Example:

{"id":"960bf258-5aa2-4a90-81fd-d2c1f7e49d2b","payment_ref_id":"123456789012","channel":"muamalat","amount":100000,"type":"payment","created_at":"2022-04-04T09:22:38+07:00","account":{"bank_code":"AMET","account_holder":"Mr. Roosevelt Hessel I","account_number":"6011930096256781","hash":"aq8vwKj2"}}

string

optional

payment_ref_id

string

optional

Payment Reference ID

channel

enum<string>

optional

Allowed values:

muamalattokopedia

Example:

muamalat

amount

number

optional

Paid amount

Example:

100000

type

string

optional

Example:

payment

account

object | null

optional

Example

{
    "event": "payment.received",
    "context": {
        "hash": "x24da1dF",
        "va_number": "8673011234567890",
        "type": "open",
        "invoice_number": "INV-001-ABC01",
        "name": "SPP Bulan Januari",
        "customer_name": "John Doe",
        "customer_email": "john.doe@example.com",
        "customer_phone": "+621234567890",
        "customer_address": "Surabaya, Indonesia",
        "total_amount": 100000,
        "billed_amount": 100000,
        "paid_amount": 0,
        "description": "Pembayaran SPP Bulan Januari",
        "ext_description": "-",
        "valid_until": "2022-04-05T13:32:08+07:00",
        "status": "active",
        "created_at": "2022-04-12T11:22:52+07:00",
        "components": [
            {
                "id": "95f5c77f-79de-4c12-a151-ef7c68e9b7d2",
                "name": "SPP Januari",
                "qty": "1",
                "price": "100000",
                "total": "100000"
            }
        ]
    },
    "payload": {
        "id": "string",
        "payment_ref_id": "string",
        "channel": "muamalat",
        "amount": 100000,
        "type": "payment",
        "created_at": "2022-04-04T09:22:38+07:00",
        "account": {
            "bank_code": "AMET",
            "account_holder": "Mr. Roosevelt Hessel I",
            "account_number": "6011930096256781",
            "hash": "aq8vwKj2"
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/' \
--header 'Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": "payment.received",
    "context": {
        "hash": "x24da1dF",
        "va_number": "8673011234567890",
        "type": "open",
        "invoice_number": "INV-001-ABC01",
        "name": "SPP Bulan Januari",
        "customer_name": "John Doe",
        "customer_email": "john.doe@example.com",
        "customer_phone": "+621234567890",
        "customer_address": "Surabaya, Indonesia",
        "total_amount": 100000,
        "billed_amount": 100000,
        "paid_amount": 0,
        "description": "Pembayaran SPP Bulan Januari",
        "ext_description": "-",
        "valid_until": "2022-04-05T13:32:08+07:00",
        "status": "active",
        "created_at": "2022-04-12T11:22:52+07:00",
        "components": [
            {
                "id": "95f5c77f-79de-4c12-a151-ef7c68e9b7d2",
                "name": "SPP Januari",
                "qty": "1",
                "price": "100000",
                "total": "100000"
            }
        ]
    },
    "payload": {
        "id": "string",
        "payment_ref_id": "string",
        "channel": "muamalat",
        "amount": 100000,
        "type": "payment",
        "created_at": "2022-04-04T09:22:38+07:00",
        "account": {
            "bank_code": "AMET",
            "account_holder": "Mr. Roosevelt Hessel I",
            "account_number": "6011930096256781",
            "hash": "aq8vwKj2"
        }
    }
}'

Responses

🟢200Response from your server

application/json

Body

object {0}

Example

{}

Institution Detail

Payment Channel API