Create New Bill - Islamic Payment Gateway

Request

Header Params

Accept

string

required

Authorization

string

required

Bearer

Signature

string

required

Body Params application/json

va_number

string

required

Unique bill number that will be converted to VA Number

>= 10 characters<= 10 characters

invoice_number

string

optional

Your transaction reference number

Example:

INV01/TRX000001

channel

enum<string>

deprecated

Allowed values:

muamalattokopedia

prefix

string | array[string]

required

6 digits BCN
You can send array of prefix to indicate that bill can be paid on those channel

Example:

009902

name

string

required

Billing name

Example:

SPP Jan 22

total_amount

number

required

Bill Total Amount

If Bill have more than 1 components total_amount is sum of each component's total value

institution_code

string

required

Your Institution Code

Example:

e9KP2zq6

type

enum<string>

required

Allowed values:

closepartial

valid_until

string <date-time>

optional

Bill valid date in ISO 8601 format

Example:

2022-04-04T11:46:56+07:00

components

array [object {4}]

optional

Bill's detail if any

name

string

required

qty

number

required

price

number

required

total

number

required

customer_name

string

required

customer_email

string

optional

customer_phone

string

optional

customer_address

string

optional

description

string

optional

Example

{
    "va_number": "1234567890",
    "invoice_number": "INV01/TRX000001",
    "channel": "muamalat",
    "prefix": "009902",
    "name": "SPP Jan 22",
    "total_amount": 0,
    "institution_code": "string",
    "type": "close",
    "valid_until": "2022-04-04T11:46:56+07:00",
    "components": [
        {
            "name": "string",
            "qty": 0,
            "price": 0,
            "total": 0
        }
    ],
    "customer_name": "string",
    "customer_email": "string",
    "customer_phone": "string",
    "customer_address": "string",
    "description": "string",
    "ext_description": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v2/gw/bill' \
--header 'Accept;' \
--header 'Authorization;' \
--header 'Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "va_number": "1234567890",
    "invoice_number": "INV01/TRX000001",
    "channel": "muamalat",
    "prefix": "009902",
    "name": "SPP Jan 22",
    "total_amount": 0,
    "institution_code": "string",
    "type": "close",
    "valid_until": "2022-04-04T11:46:56+07:00",
    "components": [
        {
            "name": "string",
            "qty": 0,
            "price": 0,
            "total": 0
        }
    ],
    "customer_name": "string",
    "customer_email": "string",
    "customer_phone": "string",
    "customer_address": "string",
    "description": "string",
    "ext_description": "string"
}'

Responses

🟢200OK

application/json

Body

rc

string

optional

message

string

optional

timestamp

string <date-time>

read-onlyoptional

Response Time at ISO-8601 format

Example:

2022-04-04T11:46:56+07:00

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": "SUCCESS",
    "message": "success",
    "timestamp": "2022-04-04T11:46:56+07:00",
    "data": {
        "hash": "x24da1dF",
        "va_number": "8673011234567890",
        "type": "close",
        "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": "-",
        "status": "active",
        "created_at": "2022-04-04T11:46:56+07:00",
        "components": [
            {
                "id": "95f5c77f-79de-4c12-a151-ef7c68e9b7d2",
                "name": "SPP Januari",
                "qty": "1",
                "price": "100000",
                "total": "100000"
            }
        ]
    }
}