Get Bill List - Islamic Payment Gateway

Get list of all bills registered on Islamic Pay

Request

Query Params

page

number

optional

Page number of the data you want to display

institution_code

string

required

Your Institution Code

date.0

string

optional

Start of date range

date.1

string

optional

End of date range

string

optional

Used to search keyword on these field: va_number, invoice_number, name, customer_name, type, status

order_by

string

optional

Parameter to order by field shown by response

order

string

optional

Direction of order (use with order_by)

Header Params

string

required

Accept application/json

Authorization

string

required

Bearer token

Signature

string

required

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

string

read-onlyoptional

Example:

SUCCESS

message

string

optional

timestamp

string <date-time>

optional

Response Time in ISO8601 format

Example:

2022-04-04T08:50:38+07:00

current_page

integer

optional

>= 1

data

array[object (Bill) {19}] | null

optional

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

from

integer

optional

>= 1

last_page

integer

optional

>= 1

per_page

integer

optional

Number of Bill data per Page

>= 1

Default:

integer

optional

>= 1

total

integer

optional

>= 0

Default:

Example

{
    "rc": "SUCCESS",
    "message": "success",
    "timestamp": "2022-04-04T10:25:46+07:00",
    "current_page": 1,
    "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,
            "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.439509Z",
            "components": [
                {
                    "id": "95f5c77f-79de-4c12-a151-ef7c68e9b7d2",
                    "name": "SPP Januari",
                    "qty": "1",
                    "price": "100000",
                    "total": "100000"
                }
            ]
        }
    ],
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 1,
    "total": 0
}