Inquiry

POST

/inquiry

Request

Header Params

Body Params application/json

Example

{
    "virtual_account": "1234567890",
    "channel": "bank_name",
    "prefix": "857499",
    "reference_id": "852963741",
    "bill_mode": "single",
    "terminal": "atm"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/inquiry' \
--header 'Authorization;' \
--header 'Signature;' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "virtual_account": "1234567890",
    "channel": "bank_name",
    "prefix": "857499",
    "reference_id": "852963741",
    "bill_mode": "single",
    "terminal": "atm"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "rc": "SUCCESS",
    "message": "success",
    "timestamp": "2022-04-05T06:11:58+07:00",
    "data": {
        "hash": "x24da1dF",
        "va_number": "8673011234567890",
        "type": "open",
        "invoice_number": "INV-02-00001",
        "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"
            }
        ],
        "additional_data": [
            {
                "key": "class (programming safe), alphanum, snake_case, lowercase",
                "label": "Kelas / Angkatan",
                "value": ""
            }
        ]
    }
}

Modified at 2024-10-17 00:55:59

Passive Client API

Payment