Institution Detail - Islamic Payment Gateway

Request

Path Params

institution-code

string

required

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/institution/' \
--header 'Accept;' \
--header 'Authorization;' \
--header 'Signature;'

Responses

🟢200OK

application/json

Body

rc

string

optional

message

string

optional

timestamp

string

optional

data

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:

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": "string",
    "message": "string",
    "timestamp": "string",
    "data": {
        "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"
    }
}