Get Payment List - Islamic Payment Gateway

Request

Query Params

institution_code

string

required

Your Institution Code

page

number

optional

Page number of the data you want to display

date.0

string

optional

Start of date range

date.1

string

optional

End of date range

order_by

string

optional

Parameter to order by field shown by response

order

string

optional

Direction of order (use with order_by)

q

string

optional

Used to search keyword on these field: va_number, payment_ref_id, channel, type

va_number

string

optional

Used to search by va_number

type

string

optional

Used to search by payment type

Header Params

Accept

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/api/v2/gw/payment?institution_code=&page=&date.0=&date.1=&order_by=&order=&q=&va_number=&type=' \
--header 'Accept;' \
--header 'Authorization;' \
--header 'Signature;'

Responses

🟢200OK

application/json

Body

rc

string

optional

Default:

SUCCESS

message

string

optional

Default:

success

timestamp

string <date-time>

optional

Response time in ISO8601 format

Example:

2022-04-04T10:34:55+07:00

current_page

number

optional

Default:

1

data

array[object (Payment Schema) {7}]

optional

>= 1 items

id

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

created_at

string <date-time>

read-onlyoptional

Pay execution time in ISO8601 format

Example:

2022-04-04T09:22:38+07:00

account

object | null

optional

from

number

optional

Default:

1

last_page

number

optional

Default:

1

per_page

number

optional

Default:

15

to

number

optional

Default:

1

total

number

optional

Default:

1

Example

{
    "rc": "SUCCESS",
    "message": "success",
    "timestamp": "2022-04-04T09:22:38+07:00",
    "current_page": 1,
    "data": [
        {
            "id": "string",
            "payment_ref_id": "string",
            "channel": "muamalat",
            "amount": 100000,
            "type": "payment",
            "created_at": "2022-04-04T09:22:38+07:00",
            "bill": {
                "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+07:00",
                "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": 1
}