Inquiry - Islamic Payment Gateway

Request

Body Params application/json

va_number

string

required

16 Digit Virtual account number that is billed.

>= 16 characters<= 16 characters

Example:

0090011234567890

ref_id

string

required

Inquiry reference ID

Example:

123456789

terminal_id

enum<string> | enum<null>

optional

Terminal where transaction happen

Allowed values:

atminternet_bankingmobile_bankingtelleredcinterbanktransfervabizchannelposother

Examples:

atmmobile_banking

transaction_date

string

required

Transaction time Format Y-m-d H:i:s

Example:

2024-12-31 20:00:00

Example

{
    "va_number": "0090011234567890",
    "ref_id": "123456789",
    "terminal_id": "atm",
    "transaction_date": "2024-12-30 20:45:50"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v2/ch/inquiry' \
--header 'Content-Type: application/json' \
--data-raw '{
    "va_number": "0090011234567890",
    "ref_id": "123456789",
    "terminal_id": "atm",
    "transaction_date": "2024-12-30 20:45:50"
}'

Responses

🟢200OK

application/json

Body

rc

string

optional

Default:

SUCCESS

message

string

optional

Default:

success

timestamp

string

optional

Example:

2022-04-05T06:11:58+07:00

data

array[object (Bill) {19}]

optional

invoice_number

string

optional

Example:

INV-001

type

enum<string>

optional

Allowed values:

openclosepartial

Example:

close

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:

0

Example:

0

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

Example

{
    "rc": "SUCCESS",
    "message": "success",
    "timestamp": "2022-04-05T06:11:58+07:00",
    "data": [
        {
            "hash": "x24da1dF",
            "va_number": "8673011234567890",
            "type": "open",
            "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-04T06:32:08+07:00",
            "components": [
                {
                    "id": "95f5c77f-79de-4c12-a151-ef7c68e9b7d2",
                    "name": "SPP Januari",
                    "qty": "1",
                    "price": "100000",
                    "total": "100000"
                }
            ]
        }
    ]
}