NAV
bash php

Pendahuluan

Setiap pemanggilan dengan Bash adalah menggunakan perkakas bernama “curl” yaitu sebuah aplikasi kecil yang berfungsi untuk melakukan pemanggilan layaknya browser kecil. Curl dapat dipergunakan dengan memberikan argumen Header maupun Payload data.

curl \
-X POST \
--header '<key header1: val header1>' \
--header '<key header2: val header2>' \
--data '<string payload, bisa berupa JSON>' \
<url endpoint>
$headers = array(
'<key header1 : val header1>',
'<key header2 : val header2>'
);
$data = '<string payload, bisa berupa JSON>';
$url = "<url endpoint>";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

$result = curl_exec($ch);
if ($result === FALSE) {
die('cURL error: '.curl_error($ch));
}
else {
print_r($result);
}
curl_close($ch);

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
},
"function": "nama_fungsi",
"status": "OK / ERR-CODE",
"msg": "Pesan dari sistem",
"ts_req": "2018-06-14 12:10:25.835366+07",
"ts_resp": "2018-06-14 12:10:26.070375+07",
"req_id": "817"
}

Selamat datang di halaman dokumentasi Smart Billing API!

Berikut ini adalah beberapa ketentuan yang perlu diketahui sebelum Anda memanggil Smart Billing API:

Akun

Daftar Akun

curl \
-X POST \
--data '{
"email":"email@email.com",
"nama_depan": "Nama Depan",
"nama_belakang": "Nama Belakang",
"password": "passwordSaya123",
"ulangi_password":"passwordSaya123",
"jenis_kelamin":"Laki-laki",
"tanggal_lahir":"1980-01-01",
"handphone":"+628118888888"
}' \
https://bayar.id/api/smartbilling/akun/daftar

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"email":"email@email.com",
"nama_depan": "Nama Depan",
"nama_belakang": "Nama Belakang",
"password": "passwordSaya123",
"ulangi_password":"passwordSaya123",
"jenis_kelamin":"Laki-laki",
"tanggal_lahir":"1980-01-01",
"handphone":"+628118888888",
"api_key": "5ad0b72d971cd6ef1f8aca83b6834b9417b90eac",
"status": "2",
"created_on": "2018-06-14T05:10:25Z"
},
"function": "akun/daftar",
"status": "OK",
"msg": "Registrasi Berhasil",
"ts_req": "2018-06-14 12:10:25.835366+07",
"ts_resp": "2018-06-14 12:10:26.070375+07",
"req_id": "817"
}

Mendaftar Akun sebagai anggota baru.
Anda akan diminta untuk mengisi data diri anda dengan lengkap dan benar, kemudian setelah mendaftar anda akan menerima email verifikasi untuk pengaktifan akun.

Pada HTTP Request tidak ada header.

Endpoint URL: https://bayar.id/api/smartbilling/akun/daftar

Field Wajib Diisi Keterangan
email Ya Email untuk registrasi anda
password Ya Password min 8 karakter ada huruf besar, huruf kecil dan angka
ulangi_password Ya Ulangi pasword anda
nama_depan Ya Nama depan anda
nama_belakang Ya Nama belakang anda
jenis_kelamin Ya Jenis kelamin anda
tanggal_lahir Ya Tanggal lahir anda
handphone Ya Nomor Handphone anda, diisi dengan menggunakan kode area, cth: +6285786206003
propinsi Ya Provinsi tempat tinggal anda
kabupaten_kota Ya Kota tempat tinggal anda
kecamatan Ya Kecamatan tempat tinggal anda
desa Ya Desa tempat tinggal anda
rt Ya RT alamat anda
rw Ya RW alamat anda
alamat Ya Alamat Jalan, Blok, Nomor
kode_pos Ya Kode Pos alamat anda
Field Keterangan
email email untuk registrasi anda
password min 8 karakter ada huruf dan angka)
ulangi_password ulangi pasword anda
nama_depan nama depan anda
nama_belakang nama belakang anda
jenis_kelamin Jenis kelamin anda
tanggal_lahir Tanggal lahir anda
handphone Nomor Handphone anda
api_key Api key yang didapat saat registrasi
status Status registrasi anda
created_on Tanggal dan waktu pada saat registrasi

Pengiriman Ulang Kode Aktivasi

curl \
-X POST \
--data '{
"email":"email@email.com"
}' \
https://bayar.id/api/smartbilling/akun/kirim-kode-pengaktifan

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"email": "email@email.com"
},
"function": "akun/kirim-kode-pengaktifan",
"status": "OK",
"msg": "Pengiriman ulang kode aktivasi Berhasil",
"ts_req": "2018-06-14 12:10:59.918952+07",
"ts_resp": "2018-06-14 12:11:00.119584+07",
"req_id": "818"
}

Pada HTTP Request tidak ada header.

Dan data di dalam payload HTML POST sebagai berikut:

{ “email”:”email@email.com“}

Field Keterangan
email email untuk registrasi anda
Field Keterangan
email email untuk registrasi anda

Aktivasi Akun

curl \
-X POST \
--data '{
"kode_aktivasi":"hrbiwebcksdjnliwh4figereysjdbjcwebjwhebvevwev"
}' \
https://bayar.id/api/smartbilling/akun/pengaktifan


Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"kode_aktivasi":"hrbiwebcksdjnliwh4figereysjdbjcwebjwhebvevwev"
},
"function": "akun/pengaktifan",
"status": "OK",
"msg": "Aktivasi Berhasil",
"ts_req": "2018-06-14 12:10:25.835366+07",
"ts_resp": "2018-06-14 12:10:26.070375+07",
"req_id": "817"
}

Pengaktifan akun sebagai anggota baru.
Saat sukses daftar, status user belum aktif hingga dia klik link yang dikirim ke email. Yang dikirim ke email adalah link berisi kode aktifasi dengan format:

https://bayar.id/smartbilling/aktivasi/<kode_aktivasi>

Field Keterangan
kode_aktivasi Kode aktifasi yang dikirimkan ke email anda
Field Keterangan
kode_aktivasi Kode aktifasi untuk mengaktifkan akun anda

Petunjuk reset password

curl \
-X POST \
--data '{
"email":"email@email.com"
}' \
https://bayar.id/api/smartbilling/akun/kirim-kode-reset-password

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"email": "email@email.com"
},
"function": "akun/kirim-kode-reset-password",
"status": "OK",
"msg": "Pengiriman ulang kode aktivasi Berhasil",
"ts_req": "2018-06-14 12:37:46.874446+07",
"ts_resp": "2018-06-14 12:37:47.128843+07",
"req_id": "835"
}

Meminta petunjuk reset password. Petunjuk akan dikirim ke email dengan format link:

https://bayar.id/smartbilling/reset-password/<kode_reset_password>

Kode reset Password akan kadaluarsa dalam 24 jam

Field Wajib Diisi Keterangan
email Ya Email anda yang akan dikirimkan petunjuk reset
Field Keterangan
email Email anda yang akan dikirimkan petunjuk reset

yang dikembalikan berupa JSON adalah hanya status pengiriman email saja

Validasi kode reset pasword

curl \
-X POST \
--data '{
"kode_reset_password":"5b43d6465be651e00d7ab39b05d37d17b6db5bdaa399189b44a5005b4fb61f594366943c"
}' \
https://bayar.id/api/smartbilling/akun/validasi-kode-reset-password

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id": 177,
"email": "email@email.com",
"nama_depan": "ASDASD",
"nama_belakang": "GIGIGIGI"
},
"function": "akun/validasi-kode-reset-password",
"status": "OK",
"msg": "Kode Reset Password Valid",
"ts_req": "2018-06-14 16:24:25.092064+07",
"ts_resp": "2018-06-14 16:24:25.151567+07",
"req_id": "878"
}

Melakukan validasi kode reset password.

Field Wajib Diisi Keterangan
kode_reset_password Ya kode reset password yang telah dikirimkan ke email anda
Field Keterangan
id ID akun anda
email Email untuk registrasi anda
nama_depan Nama depan anda
nama_belakang Nama belakang anda

Reset password

curl \
-X POST \
--data '{
"kode_reset_password":"5b43d6465be651e00d7ab39b05d37d17b6db5bdaa399189b44a5005b4fb61f594366943c",
"password":"Qweqwe123",
"ulangi_password":"Qweqwe123"
}' \
https://bayar.id/api/smartbilling/akun/reset-password


Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id": 177,
"email": "email@email.com",
"nama_depan": "ASDASD",
"nama_belakang": "GIGIGIGI"
},
"function": "akun/reset-password",
"status": "OK",
"msg": "Reset Password Sukses",
"ts_req": "2018-06-14 18:12:46.878936+07",
"ts_resp": "2018-06-14 18:12:46.989852+07",
"req_id": "925"
}

Melakukan reset password.
Anda akan diminta untuk memasukkan pasword baru. Pastikan password mengandung minimal 8 karakter, serta harus mengandung huruf besar, huruf kecil, dan karakter angka.

Dan data di dalam payload HTML POST sebagai berikut:

{ “kode_reset_password”:”5b43d6465be651e00d7ab39b05d37d17b6db5bdaa399189b44a5005b4fb61f594366943c”, “password”:”qweqweABC”, “ulangi_password”:”qweqweABC”}

Field Wajib Diisi Keterangan
kode_reset_password Ya kode reset password yang telah dikirimkan ke email anda
password Ya pasword baru anda (min 8 karakter ada huruf dan angka)
ulangi_password Ya ulangi pasword baru anda
Field Keterangan
id ID akun anda
email Email untuk registrasi anda
nama_depan Nama depan anda
nama_belakang Nama belakang anda

Otentikasi

Login (User/Password)

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan password Anda.

curl  \
-X POST \
--data '{"username":"XXXXX","password":"YYYYY"}' \
https://bayar.id/api/smartbilling/otentikasi/login-user-password
<?php
$url = "https://bayar.id/api/smartbilling/otentikasi/login-user-password";
$arr_headers = array();
$arr_payload = array(
'username' => 'suatu_email@gmail.com',
'password' => 'suatu_password'
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url;
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $arr_headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arr_payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
echo $result;
?>

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"access_token": "26a0b866b991e92f2bc6f395b180a96430bd58d6",
"expires_in": 86400,
"token_type": "Bearer",
"scope": null,
"refresh_token": "1ff8b0f4fa31886f64f1c727612424e24b61c540"
},
"function": "otentikasi/login-user-password",
"status": "OK",
"msg": "Otentikasi Berhasil",
"ts_req": "2018-06-12 14:08:33.37857+07",
"ts_resp": "2018-06-12 14:08:33.492539+07",
"req_id": "309"
}

Melakukan Login dengan User & Password. Waktu Expired login adalah 60 menit, dan akan otomatis diperpanjang 60 menit tiap kali mengakses web.

Field Keterangan
username Username Anda
password Password Anda
Field Keterangan
access_token Token hasil login Anda
expires_in Durasi waktu token berlaku (dalam detik)
token_type Tipe token
scope Lingkup token
refresh_token Token untuk melakukan perpanjangan masa berlaku token

Login (API Key)

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan API Key Anda.

curl \
-X POST \
--data '{"api_key":"YYYYY"}' \
https://bayar.id/api/smartbilling/otentikasi/login-api-key

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"access_token": "5fd08cc0c2de46ca083abc1669ceb3d91aece11e",
"expires_in": 86400,
"token_type": "Bearer",
"scope": null,
"refresh_token": "7d3270173f60079020a8704fe0368c0e95993c9d"
},
"function": "otentikasi/login-api-key",
"status": "OK",
"msg": "Otentikasi Berhasil",
"ts_req": "2018-06-12 14:25:49.003853+07",
"ts_resp": "2018-06-12 14:25:49.13147+07",
"req_id": "313"
}

Melakukan Login dengan API Key.
Waktu Expired login adalah 60 menit, dan akan otomatis diperpanjang 60 menit tiap kali akses.

Field Mandatory Keterangan
api_key Ya Api Key Anda
Field Keterangan
access_token Token hasil login Anda
expires_in Durasi waktu token berlaku (dalam detik)
token_type Tipe token
scope Lingkup token
refresh_token Token untuk melakukan perpanjangan masa berlaku token

Logout

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{"token":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}' \
https://bayar.id/api/smartbilling/otentikasi/logout

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"revoked": true
},
"function": "otentikasi/logout",
"status": "OK",
"msg": "Logout Berhasil",
"ts_req": "2018-06-12 15:18:47.226128+07",
"ts_resp": "2018-06-12 15:18:47.302092+07",
"req_id": "391"
}

Keluar dari Sistem.

Dan data di dalam payload HTML POST sebagai berikut:
{"token":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}

Field Wajib Diisi Keterangan
token Ya Token hasil login Anda
Field Keterangan
revoked Status Logout

Institusi

Menambah Institusi

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"nama_institusi": "Fakultas Ujicoba",
"deskripsi_institusi": "Fakultas yang mempelajari Ujicoba",
"bank_rekening_pelimpahan": "BSM",
"nomor_rekening_pelimpahan":"123123123123",
"nama_rekening_pelimpahan":"Ahmad Subandi",
"prefix_pembayaran":"8022",
"alamat_institusi":"Jl. Kereta Api, Jawa Timur",
"contact_person_institusi":"Bapak Budi",
"cabang_kerjasama":"KCP Hasanuddin Jakarta",
"contact_person_cabang_kerjasama":"Rahmat Widyanto, Bayu Anggoro, dkk",
"fee_per_transaksi":"2500",
"penanggung_fee":"Pembayar / Institusi",
"status_institusi": "Aktif / Non Aktif"
}' \
https://bayar.id/api/smartbilling/institusi/tambah

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "92",
"nama_institusi": "Fakultas Kalanjengking",
"deskripsi_institusi": "Fakultas yang mempelajari Kalajengking",
"bank_rekening_pelimpahan": "BSM",
"nomor_rekening_pelimpahan":"123123123123",
"nama_rekening_pelimpahan":"Ahmad Subandi",
"prefix_pembayaran":"8022",
"alamat_institusi":"Jl. Kereta Api, Jawa Timur",
"contact_person_institusi":"Bapak Budi",
"prefix_pembayaran":"8022",
"cabang_kerjasama":"KCP Hasanuddin Jakarta",
"contact_person_cabang_kerjasama":"Rahmat Widyanto, Bayu Anggoro, dkk",
"fee_per_transaksi":"2500",
"penanggung_fee":"Pembayar / Biller",
"status_institusi": "Aktif / Non Aktif",
"revisi": "0"
},
"function": "institusi/tambah",
"status": "OK",
"msg": "Create Organization sukses",
"ts_req": "2018-06-19 15:06:15.079904+07",
"ts_resp": "2018-06-19 15:06:15.212184+07",
"req_id": "1805"
}

Menambah institusi/biller baru.
Anda akan diminta mengisi kelengkapan data institusi, kemudian ketika di save id_institusi akan secara otomatis dibuat.

Field Wajib Diisi Keterangan
nama_institusi Ya Nama institusi yang akan anda tambahkan
deskripsi_institusi Ya Deskripsi singkat dari institusi yang akan anda tambahkan
parent_identifier Ya Struktur tertinggi dari institusi yang akan anda tambahkan
bank_rekening_pelimpahan Ya Nama Bank rekening pelimpahan
nomor_rekening_pelimpahan Ya Nomor rekening pelimpahan
nama_rekening_pelimpahan Ya Nama pemilik nomor rekening pelimpahan
prefix_pembayaran Ya Nomor prefix pembayaran dari institusi
cabang_kerjasama Ya Cabang bank yang kerjasama dengan institusi tsb.
contact_person_cabang_kerjasama Ya Nama kontak yang bisa dihubungi dari cabang yang kerjasama
fee_per_transaksi Ya Tarif biaya admin per transaksi
penanggung_fee Ya Penanggung pembayaran biaya admin, yaitu Pembayar / Biller
status_institusi Ya Status Institusi saat ini, yaitu Aktif / Non Aktif
Field Keterangan
id_institusi ID institusi Anda
nama_institusi Nama institusi yang akan anda tambahkan
deskripsi_institusi Deskripsi singkat dari institusi yang akan anda tambahkan
bank_rekening_pelimpahan Nama Bank rekening pelimpahan
nomor_rekening_pelimpahan Nomor rekening pelimpahan
nama_rekening_pelimpahan Nama pemilik nomor rekening pelimpahan
prefix_pembayaran Nomor prefix pembayaran dari institusi
cabang_kerjasama Cabang bank yang kerjasama dengan institusi tsb.
contact_person_cabang_kerjasama Nama kontak yang bisa dihubungi dari cabang yang kerjasama
fee_per_transaksi Tarif biaya admin per transaksi
penanggung_fee Penanggung pembayaran biaya admin, yaitu Pembayar / Biller
status_institusi Status Institusi saat ini, yaitu Aktif / Non Aktif

Ubah Institusi

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "92dh5356Bti34",
"nama_institusi": "Fakultas Kalanjengking",
"deskripsi_institusi": "Fakultas yang mempelajari Kalajengking",
"bank_rekening_pelimpahan": "BSM",
"nomor_rekening_pelimpahan":"123123123123",
"nama_rekening_pelimpahan":"Ahmad Subandi",
"prefix_pembayaran":"8022",
"alamat_institusi":"Jl. Kereta Api, Jawa Timur",
"contact_person_institusi":"Bapak Budi",
"cabang_kerjasama":"KCP Hasanuddin Jakarta",
"contact_person_cabang_kerjasama":"Rahmat Widyanto, Bayu Anggoro, dkk",
"fee_per_transaksi":"2500",
"penanggung_fee":"Pembayar / Institusi",
"status_institusi": "Aktif / Non Aktif"
}' \
https://bayar.id/api/smartbilling/institusi/ubah

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "92",
"nama_institusi": "Fakultas Kalanjengking",
"deskripsi_institusi": "Fakultas yang mempelajari Kalajengking",
"bank_rekening_pelimpahan": "BSM",
"nomor_rekening_pelimpahan":"123123123123",
"nama_rekening_pelimpahan":"Ahmad Subandi",
"prefix_pembayaran":"8022",
"alamat_institusi":"Jl. Kereta Api, Jawa Timur",
"contact_person_institusi":"Bapak Budi",
"prefix_pembayaran":"8022",
"cabang_kerjasama":"KCP Hasanuddin Jakarta",
"contact_person_cabang_kerjasama":"Rahmat Widyanto, Bayu Anggoro, dkk",
"fee_per_transaksi":"2500",
"penanggung_fee":"Pembayar / Biller",
"status_institusi": "Aktif / Non Aktif",
"revisi": "1"
},
"function": "institusi/ubah",
"status": "OK",
"msg": "Update Organization sukses",
"ts_req": "2018-06-19 16:02:07.699304+07",
"ts_resp": "2018-06-19 16:02:07.81168+07",
"req_id": "1844"
}

Mengubah data sebuah institusi

Field Wajib Diisi Keterangan
nama_institusi Ya Nama institusi yang akan anda tambahkan
deskripsi_institusi Ya Deskripsi singkat dari institusi yang akan anda tambahkan
parent_identifier Ya Struktur tertinggi dari institusi yang akan anda tambahkan
bank_rekening_pelimpahan Ya Nama Bank rekening pelimpahan
nomor_rekening_pelimpahan Ya Nomor rekening pelimpahan
nama_rekening_pelimpahan Ya Nama pemilik nomor rekening pelimpahan
prefix_pembayaran Ya Nomor prefix pembayaran dari institusi
cabang_kerjasama Ya Cabang bank yang kerjasama dengan institusi tsb.
contact_person_cabang_kerjasama Ya Nama kontak yang bisa dihubungi dari cabang yang kerjasama
fee_per_transaksi Ya Tarif biaya admin per transaksi
penanggung_fee Ya Penanggung pembayaran biaya admin, yaitu Pembayar / Biller
status_institusi Ya Status Institusi saat ini, yaitu Aktif / Non Aktif
Field Keterangan
id_institusi ID institusi Anda
nama_institusi Nama institusi yang akan anda tambahkan
deskripsi_institusi Deskripsi singkat dari institusi yang akan anda tambahkan
bank_rekening_pelimpahan Nama Bank rekening pelimpahan
nomor_rekening_pelimpahan Nomor rekening pelimpahan
nama_rekening_pelimpahan Nama pemilik nomor rekening pelimpahan
prefix_pembayaran Nomor prefix pembayaran dari institusi
cabang_kerjasama Cabang bank yang kerjasama dengan institusi tsb.
contact_person_cabang_kerjasama Nama kontak yang bisa dihubungi dari cabang yang kerjasama
fee_per_transaksi Tarif biaya admin per transaksi
penanggung_fee Penanggung pembayaran biaya admin, yaitu Pembayar / Biller
status_institusi Status Institusi saat ini, yaitu Aktif / Non Aktif
revisi nomor urut perubahan data yang telah dilakukan

Cari Institusi

Silakan ganti XXXXX dengan Token hasil otentikasi Anda

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"keyword": "coba pencarian",
"order_by": [
{"field":"status_institusi","direction":"ASC"},
{"field":"prefix_pembayaran","direction":"DESC"}
],
"offset": "0",
"limit": "2"
}' \
https://bayar.id/api/smartbilling/institusi/cari

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"keyword": "coba pencarian",
"order_by": [
{
"field": "status_institusi",
"direction": "ASC"
},
{
"field": "prefix_pembayaran",
"direction": "DESC"
}
],
"offset": "0",
"limit": "2",
"total_data": "6",
"hasil_pencarian": [
{
"id_institusi": "b2f670bee79e897297f1aa85184bbd6d",
"bank_rekening_pelimpahan": "BSM",
"nomor_rekening_pelimpahan": "123123123123",
"nama_rekening_pelimpahan": "Ahmad Subandi",
"prefix_pembayaran": "8033",
"alamat_institusi": "Jl. Kereta Api, Jawa Timur",
"contact_person_institusi": "Bapak Budi",
"cabang_kerjasama": "KCP Hasanuddin Jakarta",
"contact_person_cabang_kerjasama": "Rahmat Widyanto, Bayu Anggoro, dkk",
"fee_per_transaksi": "2500",
"penanggung_fee": "Institusi",
"status_institusi": "Aktif",
"nama_institusi": "Fakultas Eko",
"deskripsi_institusi": "Fakultas yang mempelajari Eko",
"revisi": "1",
"id_operator": "134",
"ts": "2018-07-28 23:06:44.653337"
},
{
"id_institusi": "ce3bda5f0593e25504c73df1b1806d15",
"bank_rekening_pelimpahan": "BSM",
"nomor_rekening_pelimpahan": "03023729832332",
"nama_rekening_pelimpahan": "Zubaidi Umar",
"prefix_pembayaran": "8029",
"alamat_institusi": "Jl. Kereta Api, Jawa Timur",
"contact_person_institusi": "Bapak Budi",
"cabang_kerjasama": "KCP Ujung Aspal - Jakarta",
"contact_person_cabang_kerjasama": "Rahmat Widyanto, Bayu Anggoro, dkk",
"fee_per_transaksi": "2500",
"penanggung_fee": "Pembayar",
"status_institusi": "Aktif",
"nama_institusi": "STAIMI",
"deskripsi_institusi": "SEKOLAH TINGGI AGAMA ISLAM",
"revisi": "0",
"id_operator": "134",
"ts": "2018-07-29 06:14:30.488291"
}
]
},
"function": "institusi/cari",
"status": "OK",
"msg": "Pembuatan Tagihan Baru Sukses",
"ts_req": "2018-07-29 06:49:58.470322+07",
"ts_resp": "2018-07-29 06:49:58.522591+07",
"req_id": "9144"
}

Mencari Institusi dengan kata kunci dari field yang diinginkan.

Field Wajib Diisi Keterangan
keyword Ya Kata Kunci yang akan dicari
order_by Tidak Fungsi untuk menampilkan semua data sesuai field yang kita pilih secara urut berdasarkan abjadnya (ASC/DESC)
offset Tidak Mulai dari data keberapa yang akan ditampilkan
limit Tidak Berapa data yg mau ditampilkan dari hasil pencarian
Field Keterangan
keyword Kata Kunci yang dicari
order_by Fungsi untuk menampilkan semua data sesuai field yang kita pilih secara urut berdasarkan abjadnya (ASC/DESC)
offset Mulai dari data keberapa yang akan ditampilkan
limit Berapa data yg mau ditampilkan dari hasil pencarian
total_data Total data institusi yang didapat dari kata kunci yang kita cari
hasil_pencaran Hasil seluruh data dari kata kunci yang kita cari

Pemberian Hak Akses Institusi

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "34goinsldfnklsdjf3i2oiij2io3f",
"email": "email@email.com",
"hak_akses": ["Membuat Tagihan","Melihat Tagihan","Membatalkan Tagihan"]
}' \
https://bayar.id/api/smartbilling/institusi/beri-hak-akses

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "34goinsldfnklsdjf3i2oiij2io3f",
"email": "email@email.com",
"hak_akses": ["Membuat Tagihan","Melihat Tagihan","Membatalkan Tagihan"]
},
"function": "institusi/beri-hak-akses",
"status": "OK",
"msg": "Assign Hak Akses Institusi sukses",
"ts_req": "2018-06-19 16:02:07.699304+07",
"ts_resp": "2018-06-19 16:02:07.81168+07",
"req_id": "1844"
}

Memberikan hak akses seorang operator di institusinya / sub-institusinya.

Hak akses yang diberikan akan menggantikan hak akses sebelumnya jika ada.

Jika belum terdaftar dalam keanggotaan, maka otomatis mendaftarkan sebagai anggota institusi

Field Wajib Diisi Keterangan
id_institusi Ya ID Unik untuk institusi yang akan anda ubah
email Ya email yang akan anda assign
role Ya Peran untuk akun email yang anda dafarkan Contoh : Melihat Tagihan
Field Keterangan
id_institusi ID institusi Anda
mail email yang akan anda assign
role Peran untuk akun email yang anda dafarkan Contoh : Melihat Tagihan

Pencabutan Keanggotaan Institusi

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "fakultas_kalanjengking_20180619150615",
"email": "khoirunisa@coba.com"
}' \
https://bayar.id/api/smartbilling/institusi/cabut-keanggotaan

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "fakultas_kalanjengking_20180619150615",
"email": "khoirunisa@coba.com"
},
"function": "institusi/cabut-keanggotaan",
"status": "OK",
"msg": "Assign Role Organization sukses",
"ts_req": "2018-06-19 16:02:07.699304+07",
"ts_resp": "2018-06-19 16:02:07.81168+07",
"req_id": "1844"
}

Pencabutan keanggotaan / hak akses pada sebuah Institusi.
Akun yang sudah mempunyai hak akses sebelumnya akan dihapus hak akses nya.

Pada HTTP Request harus mengandung header-header sebagai berikut:

API-Environment: trial

Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Dan data di dalam payload HTML POST sebagai berikut:

{ "id_institusi": "fakultas_kalanjengking_20180619150615", "email": "khoirunisa@coba.com" }

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi yang akan anda cabut salah satu akun angota nya
email Ya email yang akan anda hapus status keanggotaanya
Field Keterangan
id_institusi ID Institusi yang akan anda cabut salah satu akun angota nya
email email yang akan anda hapus status keanggotaanya

Daftar Anggota Institusi

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "34goinsldfnklsdjf3i2oiij2io3f"
}' \
https://bayar.id/api/smartbilling/institusi/lihat-keanggotaan

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "34goinsldfnklsdjf3i2oiij2io3f",
"nama_institusi": "Institusi ABC",
"prefix_pembayaran": "1234",
"anggota": [
{
"id_keanggotaan" : "78677687",
"nama_depan" : "Rudi",
"nama_belakang": "Hartono",
"email" : "rudi@hartono.com",
"hak_akses" : ["Membuat Tagihan","Melihat Tagihan","Membatalkan Tagihan"]
},
{
"id_keanggotaan" : "4545345",
"nama_depan" : "Ahmad",
"nama_belakang": "Suharto",
"email" : "ahmad@suharto.com",
"hak_akses" : ["Membuat Tagihan","Melihat Tagihan","Menyetujui Tagihan"]
}
]
},
"function": "institusi/lihat-keanggotaan",
"status": "OK",
"msg": "Assign Role Organization sukses",
"ts_req": "2018-06-19 16:02:07.699304+07",
"ts_resp": "2018-06-19 16:02:07.81168+07",
"req_id": "1844"
}

Daftar anggota berserta hak aksesnya.

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi yang akan anda lihat list keanggotaanya
Field Keterangan
id_institusi ID Institusi yang akan anda lihat list keanggotaanya
anggota Berisi list anggota beserta data detail seperti id anggota, nama depan, nama belakang, email dan hak akses masing-masing anggota

Mengatur Konfigurasi

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "23234234234234",
"status_notifikasi_email_pelanggan": "Aktif",
"status_notifikasi_email_institusi": "Aktif",
"tujuan_notifikasi_email_institusi": "saudagar@kaya.com",
"status_notifikasi_sms_pelanggan": "Non Aktif",
"status_notifikasi_sms_institusi": "Aktif",
"tujuan_notifikasi_sms_institusi": "+6281234567890",
"status_notifikasi_whatsapp_pelanggan" : "Non Aktif",
"status_notifikasi_whatsapp_institusi" : "Non Aktif",
"tujuan_notifikasi_whatsapp_institusi" : "+6281234567890",
"status_notifikasi_telegram_pelanggan" : "Non Aktif",
"status_notifikasi_telegram_institusi" : "Non Aktif",
"tujuan_notifikasi_telegram_institusi" : "+6281234567890",
"status_notifikasi_line_pelanggan" : "Non Aktif",
"status_notifikasi_line_institusi" : "Non Aktif",
"tujuan_notifikasi_line_institusi" : "+6281234567890",
"status_notifikasi_http_institusi" : "Aktif",
"token_notifikasi_http_institusi" : "HJGjgad786ajshdjhasgdjasjdasd",
"tujuan_notifikasi_pembayaran_http_institusi" : "https://websaya.com/notif/bayar",
"tujuan_notifikasi_pembatalan_http_institusi" : "https://websaya.com/notif/reversal",
"status_host_to_host_institusi" : "Aktif",
"token_host_to_host_institusi" : "HJGjgad786ajshdjhasgdjasjdasd",
"url_host_to_host_inquiry" : "https://websaya.com/h2h/inquiry",
"url_host_to_host_payment" : "https://websaya.com/h2h/payment",
"url_host_to_host_reversal" : "https://websaya.com/h2h/reversal",
"tindak_lanjut_kurang_bayar" : "Buat Tagihan Baru",
"tindak_lanjut_lebih_bayar" : "Tutup"
}' \
https://bayar.id/api/smartbilling/institusi/atur-konfigurasi

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "62cfda6690874eb8e3b3e05739ec8e0e",
"status_notifikasi_email_pelanggan": "Aktif",
"status_notifikasi_email_institusi": "Aktif",
"tujuan_notifikasi_email_institusi": "saudagar@kaya.com",
"status_notifikasi_sms_pelanggan": "Non Aktif",
"status_notifikasi_sms_institusi": "Aktif",
"tujuan_notifikasi_sms_institusi": "+6281234567890",
"status_notifikasi_whatsapp_pelanggan": "Non Aktif",
"status_notifikasi_whatsapp_institusi": "Non Aktif",
"tujuan_notifikasi_whatsapp_institusi": "+6281234567890",
"status_notifikasi_telegram_pelanggan": "Non Aktif",
"status_notifikasi_telegram_institusi": "Non Aktif",
"tujuan_notifikasi_telegram_institusi": "+6281234567890",
"status_notifikasi_line_pelanggan": "Non Aktif",
"status_notifikasi_line_institusi": "Non Aktif",
"tujuan_notifikasi_line_institusi": "+6281234567890",
"status_notifikasi_http_institusi": "Aktif",
"token_notifikasi_http_institusi": "HJGjgad786ajshdjhasgdjasjdasd",
"tujuan_notifikasi_pembayaran_http_institusi": "https:\/\/websaya.com\/notif\/bayar",
"tujuan_notifikasi_pembatalan_http_institusi": "https:\/\/websaya.com\/notif\/reversal",
"status_host_to_host_institusi": "Aktif",
"token_host_to_host_institusi": "HJGjgad786ajshdjhasgdjasjdasd",
"url_host_to_host_inquiry": "https:\/\/websaya.com\/h2h\/inquiry",
"url_host_to_host_payment": "https:\/\/websaya.com\/h2h\/payment",
"url_host_to_host_reversal": "https:\/\/websaya.com\/h2h\/reversal",
"tindak_lanjut_kurang_bayar": "Buat Tagihan Baru",
"tindak_lanjut_lebih_bayar": "Tutup"
},
"function": "institusi/atur-konfigurasi",
"status": "OK",
"msg": "Ubah Institusi sukses",
"ts_req": "2018-07-29 18:47:59.761246+07",
"ts_resp": "2018-07-29 18:47:59.815228+07",
"req_id": "9608"
}

Mengatur konfigurasi Institusi

Field Wajib Diisi Keterangan
id_institusi Ya id institusi yang akan anda konfigurasi
status_notifikasi_email_pelanggan Ya status pengaktifan notifikasi ke email pelanggan, yaitu Aktif/Non Aktif
status_notifikasi_email_institusi Ya status pengaktifan notifikasi ke email institusi, yaitu Aktif/Non Aktif
tujuan_notifikasi_email_institusi Ya tujuan email institusi yang digunakan untuk menerima notifikasi
status_notifikasi_sms_pelanggan Ya status pengaktifan notifikasi sms ke pelanggan, yaitu Aktif/Non Aktif
status_notifikasi_sms_institusi Ya status pengaktifan notifikasi sms ke institusi, yaitu Aktif/Non Aktif
tujuan_notifikasi_sms_institusi Ya tujuan no. HP institusi yang digunakan untuk menerima sms
status_notifikasi_whatsapp_pelanggan Ya status pengaktifan notifikasi whatsapp ke pelanggan, yaitu Aktif/Non Aktif
status_notifikasi_whatsapp_institusi Ya status pengaktifan notifikasi whatsapp ke institusi, yaitu Aktif/Non Aktif
tujuan_notifikasi_whatsapp_institusi Ya tujuan no. HP institusi yang digunakan untuk menerima pesan whatsapp
status_notifikasi_telegram_pelanggan Ya status pengaktifan notifikasi telegram ke pelanggan, yaitu Aktif/Non Aktif
status_notifikasi_telegram_institusi Ya status pengaktifan notifikasi telegram ke institusi, yaitu Aktif/Non Aktif
tujuan_notifikasi_telegram_institusi Ya tujuan no. HP institusi yang digunakan untuk menerima pesan telegram
status_notifikasi_line_pelanggan Ya status pengaktifan notifikasi line ke pelanggan, yaitu Aktif/Non Aktif
status_notifikasi_line_institusi Ya status pengaktifan notifikasi line ke institusi, yaitu Aktif/Non Aktif
tujuan_notifikasi_line_institusi Ya tujuan no. HP institusi yang digunakan untuk menerima pesan line
status_notifikasi_http_institusi Ya status pengaktifan notifikasi telegram ke pelanggan, yaitu Aktif/Non Aktif
token_notifikasi_http_institusi Ya Token institusi untuk menerima notifikasi http
tujuan_notifikasi_pembayaran_http_institusi Ya URL tujuan notifikasi pembayaran http institusi tsb.
tujuan_notifikasi_pembatalan_http_institusi Ya URL tujuan notifikasi pembatalan http institusi tsb.
status_host_to_host_institusi Ya status host to host institusi, yaitu Aktif/Non Aktif
token_host_to_host_institusi Ya Token institusi untuk host to host
url_host_to_host_inquiry Ya URL Institusi untuk host to host inquiry
url_host_to_host_payment Ya URL Institusi untuk host to host payment
url_host_to_host_reversal Ya URL Institusi untuk host to host reversal
tindak_lanjut_kurang_bayar Ya Tindak lanjut apabila terjadi kurang bayar
tindak_lanjut_lebih_bayar Ya Tindak lanjut apabila terjadi lebih bayar
Field Keterangan
id_institusi id institusi yang akan anda konfigurasi
status_notifikasi_email_pelanggan status pengaktifan notifikasi ke email pelanggan
status_notifikasi_email_institusi status pengaktifan notifikasi ke email institusi
tujuan_notifikasi_email_institusi tujuan email institusi yang digunakan untuk menerima notifikasi
status_notifikasi_sms_pelanggan status pengaktifan notifikasi sms ke pelanggan
status_notifikasi_sms_institusi status pengaktifan notifikasi sms ke institusi
tujuan_notifikasi_sms_institusi tujuan no. HP institusi yang digunakan untuk menerima sms
status_notifikasi_whatsapp_pelanggan status pengaktifan notifikasi whatsapp ke pelanggan
status_notifikasi_whatsapp_institusi status pengaktifan notifikasi whatsapp ke institusi
tujuan_notifikasi_whatsapp_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan whatsapp
status_notifikasi_telegram_pelanggan status pengaktifan notifikasi telegram ke pelanggan
status_notifikasi_telegram_institusi status pengaktifan notifikasi telegram ke institusi
tujuan_notifikasi_telegram_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan telegram
status_notifikasi_line_pelanggan status pengaktifan notifikasi line ke pelanggan
status_notifikasi_line_institusi status pengaktifan notifikasi line ke institusi
tujuan_notifikasi_line_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan line
status_notifikasi_http_institusi status pengaktifan notifikasi telegram ke pelanggan
token_notifikasi_http_institusi Token institusi untuk menerima notifikasi http
tujuan_notifikasi_pembayaran_http_institusi URL tujuan notifikasi pembayaran http institusi tsb.
tujuan_notifikasi_pembatalan_http_institusi URL tujuan notifikasi pembatalan http institusi tsb.
status_host_to_host_institusi status host to host institusi
token_host_to_host_institusi Token institusi untuk host to host
url_host_to_host_inquiry URL Institusi untuk host to host inquiry
url_host_to_host_payment URL Institusi untuk host to host payment
url_host_to_host_reversal URL Institusi untuk host to host reversal
tindak_lanjut_kurang_bayar Tindak lanjut apabila terjadi kurang bayar
tindak_lanjut_lebih_bayar Tindak lanjut apabila terjadi lebih bayar

Melihat Konfigurasi

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "i5hiuernjko3h232oifhgi5uyehrj"
}' \
https://bayar.id/api/smartbilling/institusi/lihat-konfigurasi

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "i5hiuernjko3h232oifhgi5uyehrj",
"status_notifikasi_email_pelanggan": "Aktif",
"status_notifikasi_email_institusi": "Aktif",
"tujuan_notifikasi_email_institusi": "saudagar@kaya.com",
"status_notifikasi_sms_pelanggan": "Non Aktif",
"status_notifikasi_sms_institusi": "Aktif",
"tujuan_notifikasi_sms_institusi": "+6281234567890",
"status_notifikasi_whatsapp_pelanggan" : "Non Aktif",
"status_notifikasi_whatsapp_institusi" : "Non Aktif",
"tujuan_notifikasi_whatsapp_institusi" : "+6281234567890",
"status_notifikasi_telegram_pelanggan" : "Non Aktif",
"status_notifikasi_telegram_institusi" : "Non Aktif",
"tujuan_notifikasi_telegram_institusi" : "+6281234567890",
"status_notifikasi_line_pelanggan" : "Non Aktif",
"status_notifikasi_line_institusi" : "Non Aktif",
"tujuan_notifikasi_line_institusi" : "+6281234567890",
"status_notifikasi_http" : "Aktif",
"token_notifikasi_http" : "HJGjgad786ajshdjhasg65452313%$#6djasjdasd",
"tujuan_notifikasi_pembayaran_http" : "https://websaya.com/notif/pembayaran",
"tujuan_notifikasi_pembatalan_http" : "https://websaya.com/notif/pembatalan",
"status_host_to_host" : "Aktif",
"token_host_to_host" : "HJGjgad786ajshdjhasgdjasjdasd75HGFhshlk3b^%78",
"url_host_to_host_inquiry" : "https://websaya.com/h2h/inquiry",
"url_host_to_host_payment" : "https://websaya.com/h2h/payment",
"url_host_to_host_reversal" : "https://websaya.com/h2h/reversal"
},
"function": "institusi/lihat-konfigurasi",
"status": "OK",
"msg": "Lihat Informasi Sukses",
"ts_req": "2018-06-19 06:46:30.331598+07",
"ts_resp": "2018-06-19 06:46:30.434938+07",
"req_id": "1572"
}

Melihat konfigurasi Institusi.

Field Wajib Diisi Keterangan
id_institusi Ya id institusi yang akan lihat konfigurasinya
Field Keterangan
id_institusi id institusi yang akan anda konfigurasi
status_notifikasi_email_pelanggan status pengaktifan notifikasi ke email pelanggan
status_notifikasi_email_institusi status pengaktifan notifikasi ke email institusi
tujuan_notifikasi_email_institusi tujuan email institusi yang digunakan untuk menerima notifikasi
status_notifikasi_sms_pelanggan status pengaktifan notifikasi sms ke pelanggan
status_notifikasi_sms_institusi status pengaktifan notifikasi sms ke institusi
tujuan_notifikasi_sms_institusi tujuan no. HP institusi yang digunakan untuk menerima sms
status_notifikasi_whatsapp_pelanggan status pengaktifan notifikasi whatsapp ke pelanggan
status_notifikasi_whatsapp_institusi status pengaktifan notifikasi whatsapp ke institusi
tujuan_notifikasi_whatsapp_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan whatsapp
status_notifikasi_telegram_pelanggan status pengaktifan notifikasi telegram ke pelanggan
status_notifikasi_telegram_institusi status pengaktifan notifikasi telegram ke institusi
tujuan_notifikasi_telegram_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan telegram
status_notifikasi_line_pelanggan status pengaktifan notifikasi line ke pelanggan
status_notifikasi_line_institusi status pengaktifan notifikasi line ke institusi
tujuan_notifikasi_line_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan line
status_notifikasi_http_institusi status pengaktifan notifikasi telegram ke pelanggan
token_notifikasi_http_institusi Token institusi untuk menerima notifikasi http
tujuan_notifikasi_pembayaran_http_institusi URL tujuan notifikasi pembayaran http institusi tsb.
tujuan_notifikasi_pembatalan_http_institusi URL tujuan notifikasi pembatalan http institusi tsb.
status_host_to_host_institusi status host to host institusi
token_host_to_host_institusi Token institusi untuk host to host
url_host_to_host_inquiry URL Institusi untuk host to host inquiry
url_host_to_host_payment URL Institusi untuk host to host payment
url_host_to_host_reversal URL Institusi untuk host to host reversal
tindak_lanjut_kurang_bayar Tindak lanjut apabila terjadi kurang bayar
tindak_lanjut_lebih_bayar Tindak lanjut apabila terjadi lebih bayar

Melihat Profil Institusi

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "i5hiuernjko3h232oifhgi5uyehrj"
}' \
https://bayar.id/api/smartbilling/institusi/profil

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "i5hiuernjko3h232oifhgi5uyehrj",
"status_notifikasi_email_pelanggan": "Aktif",
"status_notifikasi_email_institusi": "Aktif",
"tujuan_notifikasi_email_institusi": "saudagar@kaya.com",
"status_notifikasi_sms_pelanggan": "Non Aktif",
"status_notifikasi_sms_institusi": "Aktif",
"tujuan_notifikasi_sms_institusi": "+6281234567890",
"status_notifikasi_whatsapp_pelanggan" : "Non Aktif",
"status_notifikasi_whatsapp_institusi" : "Non Aktif",
"tujuan_notifikasi_whatsapp_institusi" : "+6281234567890",
"status_notifikasi_telegram_pelanggan" : "Non Aktif",
"status_notifikasi_telegram_institusi" : "Non Aktif",
"tujuan_notifikasi_telegram_institusi" : "+6281234567890",
"status_notifikasi_line_pelanggan" : "Non Aktif",
"status_notifikasi_line_institusi" : "Non Aktif",
"tujuan_notifikasi_line_institusi" : "+6281234567890",
"status_notifikasi_http" : "Aktif",
"token_notifikasi_http" : "HJGjgad786ajshdjhasg65452313%$#6djasjdasd",
"tujuan_notifikasi_pembayaran_http" : "https://websaya.com/notif/pembayaran",
"tujuan_notifikasi_pembatalan_http" : "https://websaya.com/notif/pembatalan",
"status_host_to_host" : "Aktif",
"token_host_to_host" : "HJGjgad786ajshdjhasgdjasjdasd75HGFhshlk3b^%78",
"url_host_to_host_inquiry" : "https://websaya.com/h2h/inquiry",
"url_host_to_host_payment" : "https://websaya.com/h2h/payment",
"url_host_to_host_reversal" : "https://websaya.com/h2h/reversal"
},
"function": "institusi/profil",
"status": "OK",
"msg": "Lihat Informasi Sukses",
"ts_req": "2018-06-19 06:46:30.331598+07",
"ts_resp": "2018-06-19 06:46:30.434938+07",
"req_id": "1572"
}

Melihat konfigurasi Institusi

Field Wajib Diisi Keterangan
id_institusi Ya id institusi yang akan lihat profil nya
Field Keterangan
id_institusi id institusi yang akan anda lihat profil nya
status_notifikasi_email_pelanggan status pengaktifan notifikasi ke email pelanggan
status_notifikasi_email_institusi status pengaktifan notifikasi ke email institusi
tujuan_notifikasi_email_institusi tujuan email institusi yang digunakan untuk menerima notifikasi
status_notifikasi_sms_pelanggan status pengaktifan notifikasi sms ke pelanggan
status_notifikasi_sms_institusi status pengaktifan notifikasi sms ke institusi
tujuan_notifikasi_sms_institusi tujuan no. HP institusi yang digunakan untuk menerima sms
status_notifikasi_whatsapp_pelanggan status pengaktifan notifikasi whatsapp ke pelanggan
status_notifikasi_whatsapp_institusi status pengaktifan notifikasi whatsapp ke institusi
tujuan_notifikasi_whatsapp_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan whatsapp
status_notifikasi_telegram_pelanggan status pengaktifan notifikasi telegram ke pelanggan
status_notifikasi_telegram_institusi status pengaktifan notifikasi telegram ke institusi
tujuan_notifikasi_telegram_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan telegram
status_notifikasi_line_pelanggan status pengaktifan notifikasi line ke pelanggan
status_notifikasi_line_institusi status pengaktifan notifikasi line ke institusi
tujuan_notifikasi_line_institusi tujuan no. HP institusi yang digunakan untuk menerima pesan line
status_notifikasi_http_institusi status pengaktifan notifikasi telegram ke pelanggan
token_notifikasi_http_institusi Token institusi untuk menerima notifikasi http
tujuan_notifikasi_pembayaran_http_institusi URL tujuan notifikasi pembayaran http institusi tsb.
tujuan_notifikasi_pembatalan_http_institusi URL tujuan notifikasi pembatalan http institusi tsb.
status_host_to_host_institusi status host to host institusi
token_host_to_host_institusi Token institusi untuk host to host
url_host_to_host_inquiry URL Institusi untuk host to host inquiry
url_host_to_host_payment URL Institusi untuk host to host payment
url_host_to_host_reversal URL Institusi untuk host to host reversal
tindak_lanjut_kurang_bayar Tindak lanjut apabila terjadi kurang bayar
tindak_lanjut_lebih_bayar Tindak lanjut apabila terjadi lebih bayar

Tagihan

Buat Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"minimal_pembayaran": "0",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"open_payment": "f",
"open_amount": "t",
"terima_pembayaran_kurang": "t",
"terima_pembayaran_lebih": "f",
"action_pembayaran_kurang": "Membuat Tagihan Baru",
"action_pembayaran_lebih": "Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan",
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Persetujuan"
}' \
https://bayar.id/api/smartbilling/tagihan/tambah
<?php
$url = "https://bayar.id/api/smartbilling/tagihan/tambah";

$token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$arr_headers = array(
'API-Environment: trial',
'Authorization: Bearer ' . $token
);
$arr_payload = array (
'id_institusi' => '2373278237823782378',
'nomor_invoice' => 'ABC12321AA37/TAG/2017',
'nomor_pembayaran' => '0806444524',
'waktu_berlaku' => '2018-01-01',
'waktu_jatuh_tempo' => '2020-01-01',
'waktu_kedaluwarsa' => '2020-01-01',
'email' => 'coba@coba.com',
'nama' => 'AHMAD YANTO',
'nomor_hp' => '081188990579',
'catatan' => 'Ini percobaan 1',
'minimal_pembayaran' => '0',
'id_pelanggan' => '0806444524',
'informasi' => array (
0 => array (
'judul' => 'Info 1',
'isi' => 'Bayar Kuliah',
'tipe' => 'inq_pay',
),
1 => array (
'judul' => 'Info 2',
'isi' => 'Semester Genap 2018',
'tipe' => 'inq_pay',
),
),
'rincian' => array (
0 => array (
'kode_akun' => '001',
'deskripsi' => 'Tagihan',
'nominal' => '1200000',
),
1 => array (
'kode_akun' => '002',
'deskripsi' => 'Denda',
'nominal' => '300000',
),
),
'open_payment' => 'f',
'open_amount' => 't',
'terima_pembayaran_kurang' => 't',
'terima_pembayaran_lebih' => 'f',
'action_pembayaran_kurang' => 'Membuat Tagihan Baru',
'action_pembayaran_lebih' => 'Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan',
'label' => array (
0 => 'Pak Agus',
1 => 'Medan',
),
'status_tagihan' => 'Menunggu Persetujuan',
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url;
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $arr_headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arr_payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
echo $result;
?>

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"minimal_pembayaran": "0",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"open_payment" : "f",
"open_amount" : "t",
"terima_pembayaran_kurang" : "t",
"terima_pembayaran_lebih" : "f",
"action_pembayaran_kurang" : "Membuat Tagihan Baru",
"action_pembayaran_lebih" : "Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan",
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Pemeriksaan",
"id_tagihan" : "444",
"revisi" : "0"
},
"function": "tambah",
"status": "OK",
"msg": "Pembuatan Tagihan Baru Sukses",
"ts_req": "2018-06-20 01:10:03.205389+07",
"ts_resp": "2018-06-20 01:10:04.560817+07",
"req_id": "1888"
}
curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"open_payment" : "f",
"open_amount" : "t",
"terima_pembayaran_kurang" : "t",
"terima_pembayaran_lebih" : "f",
"action_pembayaran_kurang" : "Membuat Tagihan Baru",
"action_pembayaran_lebih" : "Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan",
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Persetujuan"
}' \
https://bayar.id/api/smartbilling/tagihan/tambah

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"open_payment" : "f",
"open_amount" : "t",
"terima_pembayaran_kurang" : "t",
"terima_pembayaran_lebih" : "f",
"action_pembayaran_kurang" : "Membuat Tagihan Baru",
"action_pembayaran_lebih" : "Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan",
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Pemeriksaan",
"id_tagihan" : "444",
"revisi" : "0"
},
"function": "tambah",
"status": "OK",
"msg": "Pembuatan Tagihan Baru Sukses",
"ts_req": "2018-06-20 01:10:03.205389+07",
"ts_resp": "2018-06-20 01:10:04.560817+07",
"req_id": "1888"
}

Membuat tagihan untuk customer institusi tertentu.

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
nomor_pembayaran Ya Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
nama Ya Informasi nama yang ingin ditagih
informasi Ya Minimal diisi 1 set {‘label’, ‘info’, ‘tipe’}. Atribut ‘tipe’ dapat diisi dengan nilai ‘inq’, ‘pay’ atau ‘inq_pay’ (default). Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
rincian Ya Minimal diisi 1 set {‘kode_akun’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Tidak Nomor Invoice dari Institusi Anda
waktu_berlaku Tidak Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Tidak Waktu jatuh tempo.
waktu_kedaluwarsa Tidak Waktu kedaluwarsa.
email Tidak Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Tidak Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
id_pelanggan Tidak Nomor pelanggan di lingkungan internal Institusi Anda
klasifikasi Tidak Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Tidak Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi
label Tidak Informasi untuk label, bisa lebih dari satu label
status_tagihan Tidak Informasi status tagihan, dengan pilihan: “Menunggu Pemeriksaan”, “Menunggu Persetujuan”, “Menunggu Pembayaran”
open_payment Tidak Tipe tagihan, dengan pilihan: “t” atau “f”
open_amount Tidak Tipe tagihan bisa dibayar sesuai nominal tertera atau tidak, dengan pilihan: “t” atau “f”
terima_pembayaran_kurang Tidak Required open_amount bernilai “t”, dengan pilihan “t” atau “f”
terima_pembayaran_lebih Tidak Required open_amount bernilai “t”, dengan pilihan “t” atau “f”
action_pembayaran_kurang Tidak Required terima_pembayaran_kurang bernilai “t”, dengan pilihan: “Terima & Tutup Tagihan”, dan “Membuat Tagihan Baru”
action_pembayaran_lebih Tidak Required terima_pembayaran_lebih bernilai “t”, dengan pilihan: “Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan”, “Diterima sebagai Pendapatan Institusi”, “Dikembalikan ke Pelanggan”, “Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan”
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda
nomor_pembayaran Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
nama Informasi nama yang ingin ditagih
informasi Minimal diisi 1 set {‘label’, ‘info’, ‘tipe’}. Atribut ‘tipe’ dapat diisi dengan nilai ‘inq’, ‘pay’ atau ‘inq_pay’ (default). Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
rincian Minimal diisi 1 set {‘kode_akun’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Nomor Invoice dari Institusi Anda
waktu_berlaku Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Waktu jatuh tempo.
waktu_kedaluwarsa Waktu kedaluwarsa.
email Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
id_pelanggan Nomor pelanggan di lingkungan internal Institusi Anda
klasifikasi Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi
label Informasi untuk label, bisa lebih dari satu label
revisi Nomor Revisi atas tagihan ini
status_tagihan Informasi status tagihan, dengan pilihan: “Menunggu Pemeriksaan”, “Menunggu Persetujuan”, “Menunggu Pembayaran”
open_payment Tipe tagihan, dengan pilihan: “t” atau “f”
open_amount Tipe tagihan bisa dibayar sesuai nominal tertera atau tidak, dengan pilihan: “t” atau “f”
terima_pembayaran_kurang Required open_amount bernilai “t”, dengan pilihan “t” atau “f”
terima_pembayaran_lebih Required open_amount bernilai “t”, dengan pilihan “t” atau “f”
action_pembayaran_kurang Required terima_pembayaran_kurang bernilai “t”, dengan pilihan: “Terima & Tutup Tagihan”, dan “Membuat Tagihan Baru”
action_pembayaran_lebih Required terima_pembayaran_lebih bernilai “t”, dengan pilihan: “Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan”, “Diterima sebagai Pendapatan Institusi”, “Dikembalikan ke Pelanggan”, “Dimasukkan ke Virtual Account Pelanggan & Tutup Tagihan”

Buat Multiple Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_batch":"782",
"data_tagihan": [
{
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"minimal_pembayaran": "0",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Persetujuan"
},
{
"id_institusi":"2373278237823782378",
"nomor_invoice":"INVOICE2/TAG/2017",
"nomor_pembayaran":"123456",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba2@coba.com",
"nama": "MULTIPLE 2",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"minimal_pembayaran": "0",
"id_pelanggan":"123456",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Pembayaran"
}
]
}' \
https://bayar.id/api/smartbilling/tagihan/multi-tambah
<?php
$url = "https://bayar.id/api/smartbilling/tagihan/multi-tambah";

$token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$arr_headers = array(
'API-Environment: trial',
'Authorization: Bearer ' . $token
);
$arr_payload = array (
'id_institusi' => '2373278237823782378',
'id_batch' => '782',
'data_tagihan' => array(
array (
'id_institusi' => '2373278237823782378',
'nomor_invoice' => 'ABC12321AA37/TAG/2017',
'nomor_pembayaran' => '0806444524',
'waktu_berlaku' => '2018-01-01',
'waktu_jatuh_tempo' => '2020-01-01',
'waktu_kedaluwarsa' => '2020-01-01',
'email' => 'coba@coba.com',
'nama' => 'AHMAD YANTO',
'nomor_hp' => '081188990579',
'catatan' => 'Ini percobaan 1',
'minimal_pembayaran' => '0',
'id_pelanggan' => '0806444524',
'informasi' => array (
0 => array (
'judul' => 'Info 1',
'isi' => 'Bayar Kuliah',
'tipe' => 'inq_pay',
),
1 => array (
'judul' => 'Info 2',
'isi' => 'Semester Genap 2018',
'tipe' => 'inq_pay',
),
),
'rincian' => array (
0 => array (
'kode_akun' => '001',
'deskripsi' => 'Tagihan',
'nominal' => '1200000',
),
1 => array (
'kode_akun' => '002',
'deskripsi' => 'Denda',
'nominal' => '300000',
),
),
'label' => array (
0 => 'Pak Agus',
1 => 'Medan',
),
'status_tagihan' => 'Menunggu Persetujuan',
),
array (
'id_institusi' => '2373278237823782378',
'nomor_invoice' => 'INVOICE2/TAG/2017',
'nomor_pembayaran' => '123456',
'waktu_berlaku' => '2018-01-01',
'waktu_jatuh_tempo' => '2020-01-01',
'waktu_kedaluwarsa' => '2020-01-01',
'email' => 'coba@coba.com',
'nama' => 'MULTI 2',
'nomor_hp' => '081188990579',
'catatan' => 'Ini percobaan 2',
'minimal_pembayaran' => '0',
'id_pelanggan' => '123456',
'informasi' => array (
0 => array (
'judul' => 'Info 1',
'isi' => 'Bayar Kuliah',
'tipe' => 'inq_pay',
),
1 => array (
'judul' => 'Info 2',
'isi' => 'Semester Genap 2018',
'tipe' => 'inq_pay',
),
),
'rincian' => array (
0 => array (
'kode_akun' => '001',
'deskripsi' => 'Tagihan',
'nominal' => '1200000',
),
1 => array (
'kode_akun' => '002',
'deskripsi' => 'Denda',
'nominal' => '300000',
),
),
'label' => array (
0 => 'Pak Agus',
1 => 'Medan',
),
'status_tagihan' => 'Menunggu Pembayaran',
),
),
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url;
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $arr_headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arr_payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
echo $result;
?>

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_tagihan" : "444",
"nomor_invoice": "ABC12321AA37/TAG/2017",
"status": "OK",
"msg": "Pembuatan Tagihan Invoice: ABC12321AA37/TAG/2017, ID Pelanggan: 0806444524, Nomor Pembayaran: 0806444524 Sukses"
},
{
"id_tagihan" : "445",
"nomor_invoice": "INVOICE2/TAG/2017",
"status": "OK",
"msg": "Pembuatan Tagihan Invoice: INVOICE2/TAG/2017, ID Pelanggan: 123456, Nomor Pembayaran: 123456 Sukses"
}
],
"function": "multi-tambah",
"status": "OK",
"msg": "Tambah Tagihan Selesai Diproses",
"ts_req": "2018-06-20 01:10:03.205389+07",
"ts_resp": "2018-06-20 01:10:04.560817+07",
"req_id": "1888"
}

Membuat multi tagihan untuk customer institusi tertentu.

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
id_batch Ya ID Batch Pemrosesan
daftar_tagihan Ya Informasi tagihan yang sesuai dengan fungsi tambah
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
daftar_tagihan Informasi tagihan yang sesuai dengan fungsi tambah

Ubah Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi Anda

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_tagihan":"230",
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"minimal_pembayaran": "0",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Lab Kimia", "Depok"],
"status_tagihan" : "Menunggu Persetujuan"
}' \
https://bayar.id/api/smartbilling/tagihan/ubah
<?php
$url = "https://bayar.id/api/smartbilling/tagihan/ubah";

$token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$arr_headers = array(
'API-Environment: trial',
'Authorization: Bearer ' . $token
);
$arr_payload = array (
"id_tagihan":"230",
'id_institusi' => '2373278237823782378',
'nomor_invoice' => 'ABC12321AA37/TAG/2017',
'nomor_pembayaran' => '0806444524',
'waktu_berlaku' => '2018-01-01',
'waktu_jatuh_tempo' => '2020-01-01',
'waktu_kedaluwarsa' => '2020-01-01',
'email' => 'coba@coba.com',
'nama' => 'AHMAD YANTO',
'nomor_hp' => '081188990579',
'catatan' => 'Ini percobaan 1',
'minimal_pembayaran' => '0',
'id_pelanggan' => '0806444524',
'informasi' => array (
0 => array (
'judul' => 'Info 1',
'isi' => 'Bayar Kuliah',
'tipe' => 'inq_pay',
),
1 => array (
'judul' => 'Info 2',
'isi' => 'Semester Genap 2018',
'tipe' => 'inq_pay',
),
),
'rincian' => array (
0 => array (
'kode_akun' => '001',
'deskripsi' => 'Tagihan Semesteran',
'nominal' => '1200000',
),
1 => array (
'kode_akun' => '002',
'deskripsi' => 'Denda',
'nominal' => '300000',
),
),
'label' => array (
0 => 'Pak Agus',
1 => 'Medan',
),
'status_tagihan' => 'Menunggu Persetujuan',
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url;
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $arr_headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arr_payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
echo $result;
?>

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_tagihan":"230",
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan ubah",
"minimal_pembayaran": "0",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Lab Kimia", "Depok"],
"revisi" : "2"
},
"function": "tagihan/ubah",
"status": "OK",
"msg": "Pengubahan Tagihan Sukses",
"ts_req": "2018-06-20 01:10:04.205389+07",
"ts_resp": "2018-06-20 01:10:05.560817+07",
"req_id": "1889"
}

Mengubah Tagihan yang belum dibayar

Field Wajib Diisi Keterangan
id_tagihan Ya ID tagihan di dalam sistem Smart Billing
id_institusi Ya ID Institusi Anda
nomor_pembayaran Ya Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
nama Ya Informasi nama yang ingin ditagih
informasi Ya Minimal diisi 1 set {‘label’ & ‘info’}. Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
rincian Ya Minimal diisi 1 set {‘kode_akun’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Tidak Nomor Invoice dari Institusi Anda
waktu_berlaku Tidak Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Tidak Waktu jatuh tempo.
waktu_kedaluwarsa Tidak Waktu kedaluwarsa.
email Tidak Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Tidak Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
id_pelanggan Tidak Nomor pelanggan di lingkungan internal Institusi Anda
klasifikasi Tidak Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Tidak Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi
label Tidak Informasi untuk label, bisa lebih dari satu label
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda
nomor_pembayaran Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
nama Informasi nama yang ingin ditagih
informasi Minimal diisi 1 set {‘label’ & ‘info’}. Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
rincian Minimal diisi 1 set {‘kode_akun’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Nomor Invoice dari Institusi Anda
waktu_berlaku Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Waktu jatuh tempo.
waktu_kedaluwarsa Waktu kedaluwarsa.
email Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
id_pelanggan Nomor pelanggan di lingkungan internal Institusi Anda
klasifikasi Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi
label Informasi untuk label, bisa lebih dari satu label
revisi Nomor Revisi atas tagihan ini

Ubah Status Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi Anda

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_tagihan": ["230","241"],
"id_institusi":"2373278237823782378",
"status_tagihan" : "Menunggu Persetujuan"
}' \
https://bayar.id/api/smartbilling/tagihan/ubah

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_tagihan": ["230","241"],
"id_institusi":"2373278237823782378",
"status_tagihan" : "Menunggu Persetujuan"
},
"function": "tagihan/ubah-status",
"status": "OK",
"msg": "Pengubahan Status Tagihan Sukses",
"ts_req": "2018-06-20 01:10:04.205389+07",
"ts_resp": "2018-06-20 01:10:05.560817+07",
"req_id": "1889"
}

Mengubah Tagihan yang belum dibayar

Field Wajib Diisi Keterangan
id_tagihan Ya ID tagihan di dalam sistem Smart Billing
id_institusi Ya ID Institusi Anda
nomor_pembayaran Ya Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
nama Ya Informasi nama yang ingin ditagih
informasi Ya Minimal diisi 1 set {‘label’ & ‘info’}. Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
rincian Ya Minimal diisi 1 set {‘kode’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Tidak Nomor Invoice dari Institusi Anda
waktu_berlaku Tidak Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Tidak Waktu jatuh tempo.
waktu_kedaluwarsa Tidak Waktu kedaluwarsa.
email Tidak Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Tidak Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
id_pelanggan Tidak Nomor pelanggan di lingkungan internal Institusi Anda
klasifikasi Tidak Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Tidak Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi
label Tidak Informasi untuk label, bisa lebih dari satu label
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda
nomor_pembayaran Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
nama Informasi nama yang ingin ditagih
informasi Minimal diisi 1 set {‘label’ & ‘info’}. Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
rincian Minimal diisi 1 set {‘kode’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Nomor Invoice dari Institusi Anda
waktu_berlaku Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Waktu jatuh tempo.
waktu_kedaluwarsa Waktu kedaluwarsa.
email Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
id_pelanggan Nomor pelanggan di lingkungan internal Institusi Anda
klasifikasi Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi
label Informasi untuk label, bisa lebih dari satu label
revisi Nomor Revisi atas tagihan ini

Ubah Multiple Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"data_tagihan": [
{
"id_tagihan" : "444",
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"minimal_pembayaran": "0",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Persetujuan"
},
{
"id_tagihan" : "445",
"id_institusi":"2373278237823782378",
"nomor_invoice":"INVOICE2/TAG/2017",
"nomor_pembayaran":"123456",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba2@coba.com",
"nama": "MULTIPLE 2",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"minimal_pembayaran": "0",
"id_pelanggan":"123456",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Pembayaran"
}
]
}' \
https://bayar.id/api/smartbilling/tagihan/multi-ubah
<?php
$url = "https://bayar.id/api/smartbilling/tagihan/multi-ubah";

$token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$arr_headers = array(
'API-Environment: trial',
'Authorization: Bearer ' . $token
);
$arr_payload = array (
'id_institusi' => '2373278237823782378',
'data_tagihan' => array(
array (
'id_tagihan' => '444',
'id_institusi' => '2373278237823782378',
'nomor_invoice' => 'ABC12321AA37/TAG/2017',
'nomor_pembayaran' => '0806444524',
'waktu_berlaku' => '2018-01-01',
'waktu_jatuh_tempo' => '2020-01-01',
'waktu_kedaluwarsa' => '2020-01-01',
'email' => 'coba@coba.com',
'nama' => 'AHMAD YANTO',
'nomor_hp' => '081188990579',
'catatan' => 'Ini percobaan 1',
'minimal_pembayaran' => '0',
'id_pelanggan' => '0806444524',
'informasi' => array (
0 => array (
'judul' => 'Info 1',
'isi' => 'Bayar Kuliah',
'tipe' => 'inq_pay',
),
1 => array (
'judul' => 'Info 2',
'isi' => 'Semester Genap 2018',
'tipe' => 'inq_pay',
),
),
'rincian' => array (
0 => array (
'kode_akun' => '001',
'deskripsi' => 'Tagihan',
'nominal' => '1200000',
),
1 => array (
'kode_akun' => '002',
'deskripsi' => 'Denda',
'nominal' => '300000',
),
),
'label' => array (
0 => 'Pak Agus',
1 => 'Medan',
),
'status_tagihan' => 'Menunggu Persetujuan',
),
array (
'id_tagihan' => '445',
'id_institusi' => '2373278237823782378',
'nomor_invoice' => 'INVOICE2/TAG/2017',
'nomor_pembayaran' => '123456',
'waktu_berlaku' => '2018-01-01',
'waktu_jatuh_tempo' => '2020-01-01',
'waktu_kedaluwarsa' => '2020-01-01',
'email' => 'coba@coba.com',
'nama' => 'MULTI 2',
'nomor_hp' => '081188990579',
'catatan' => 'Ini percobaan 2',
'minimal_pembayaran' => '0',
'id_pelanggan' => '123456',
'informasi' => array (
0 => array (
'judul' => 'Info 1',
'isi' => 'Bayar Kuliah',
'tipe' => 'inq_pay',
),
1 => array (
'judul' => 'Info 2',
'isi' => 'Semester Genap 2018',
'tipe' => 'inq_pay',
),
),
'rincian' => array (
0 => array (
'kode_akun' => '001',
'deskripsi' => 'Tagihan',
'nominal' => '1200000',
),
1 => array (
'kode_akun' => '002',
'deskripsi' => 'Denda',
'nominal' => '300000',
),
),
'label' => array (
0 => 'Pak Agus',
1 => 'Medan',
),
'status_tagihan' => 'Menunggu Pembayaran',
),
),
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url;
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $arr_headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arr_payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
echo $result;
?>

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_tagihan": "444",
"nomor_invoice": "ABC12321AA37/TAG/2017",
"status": "OK",
"msg": "Ubah Tagihan Invoice: ABC12321AA37/TAG/2017, ID Pelanggan: 0806444524, Nomor Pembayaran: 0806444524 Sukses"
},
{
"id_tagihan": "445",
"nomor_invoice": "INVOICE2/TAG/2017",
"status": "OK",
"msg": "Ubah Tagihan Invoice: INVOICE2/TAG/2017, ID Pelanggan: 123456, Nomor Pembayaran: 123456 Sukses"
}
],
"function": "multi-ubah",
"status": "OK",
"msg": "Ubah Tagihan selesai diproses",
"ts_req": "2018-06-20 01:10:03.205389+07",
"ts_resp": "2018-06-20 01:10:04.560817+07",
"req_id": "1888"
}

Mengubah multi tagihan untuk customer institusi tertentu.

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
daftar_tagihan Ya Informasi tagihan yang sesuai dengan fungsi tambah
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
daftar_tagihan Informasi tagihan yang sesuai dengan fungsi tambah

Batalkan Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_tagihan": ["230","240","234"]
}' \
https://bayar.id/api/smartbilling/tagihan/batalkan

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"id_tagihan":["230","240","234"]
},
"function": "tagihan/batalkan",
"status": "OK",
"msg": "Pembatalan Tagihan Sukses",
"ts_req": "2018-06-20 01:10:04.205389+07",
"ts_resp": "2018-06-20 01:10:05.560817+07",
"req_id": "1890"
}

Membatalkan Tagihan yang belum dibayar

Field Wajib Diisi Keterangan
id_tagihan Ya ID tagihan di dalam sistem Smart Billing, minimal 1 id_tagihan
id_institusi Ya ID Institusi Anda
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda

Hapus Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_tagihan": ["230","240","234"]
}' \
https://bayar.id/api/smartbilling/tagihan/hapus

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"id_tagihan":["230","240","234"]
},
"function": "tagihan/hapus",
"status": "OK",
"msg": "Penghapusan Tagihan Sukses",
"ts_req": "2018-06-20 01:10:04.205389+07",
"ts_resp": "2018-06-20 01:10:05.560817+07",
"req_id": "1890"
}

Menghapus Tagihan yang belum dibayar

Field Wajib Diisi Keterangan
id_tagihan Ya ID tagihan di dalam sistem Smart Billing, minimal 1 id_tagihan
id_institusi Ya ID Institusi Anda
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda

Detail Tagihan

Id Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi Anda

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_tagihan": "230"
}' \
https://bayar.id/api/smartbilling/tagihan/detail

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_tagihan":"230",
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan ubah",
"id_pelanggan":"0806444524",
"informasi": [
{
"label": "Info1",
"info": "Bayar Kuliah"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"kode_klasifikasi": "FAK",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"kode_klasifikasi": "ANGK",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Lab Kimia", "Depok"],
"status_tagihan" : "Menunggu Persetujuan",
"revisi" : "2",
"daftar_revisi": [
{
"revisi" : "3",
"tanggal_revisi": "2018-06-20 01:10:04.205389+07",
"id_user": "12",
"nama_user": "Agus Budi"
},
{
"revisi" : "2",
"tanggal_revisi": "2018-06-19 01:10:04.205389+07",
"id_user": "172",
"nama_user": "Mohammad Fajri"
},
{
"revisi" : "1",
"tanggal_revisi": "2018-06-28 01:10:04.205389+07",
"id_user": "12",
"nama_user": "Agus Budi"
}
]
},
"function": "tagihan/detail",
"status": "OK",
"msg": "Pengambilan Detail Tagihan Sukses",
"ts_req": "2018-06-20 01:10:04.205389+07",
"ts_resp": "2018-06-20 01:10:05.560817+07",
"req_id": "1870"
}

Mendapatkan Detail Tagihan berdasarkan ID Tagihan

Field Wajib Diisi Keterangan
id_tagihan Ya ID tagihan di dalam sistem Smart Billing
id_institusi Ya ID Institusi Anda
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda
nomor_pembayaran Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
nama Informasi nama yang ingin ditagih
informasi Minimal diisi 1 set {‘label’ & ‘info’}. Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
rincian Minimal diisi 1 set {‘kode’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Nomor Invoice dari Institusi Anda
waktu_berlaku Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Waktu jatuh tempo.
waktu_kedaluwarsa Waktu kedaluwarsa.
email Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
id_pelanggan Nomor pelanggan di lingkungan internal Institusi Anda
klasifikasi Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi
label Informasi untuk label, bisa lebih dari satu label
revisi Nomor Revisi atas tagihan ini
daftar_revisi Berisi riwayat penambahan dan perubahan tagihan

Nomor Invoice

Silakan ganti XXXXX dengan token hasil otentikasi Anda

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"nomor_invoice": "ABC12321AA37/TAG/2017"
}' \
https://bayar.id/api/smartbilling/tagihan/detail

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_tagihan":"230",
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan ubah",
"id_pelanggan":"0806444524",
"informasi": [
{
"label": "Info1",
"info": "Bayar Kuliah"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"kode_klasifikasi": "FAK",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"kode_klasifikasi": "ANGK",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Lab Kimia", "Depok"],
"status_tagihan" : "Menunggu Persetujuan",
"revisi" : "2",
"daftar_revisi": [
{
"revisi" : "3",
"tanggal_revisi": "2018-06-20 01:10:04.205389+07",
"id_user": "12",
"nama_user": "Agus Budi"
},
{
"revisi" : "2",
"tanggal_revisi": "2018-06-19 01:10:04.205389+07",
"id_user": "172",
"nama_user": "Mohammad Fajri"
},
{
"revisi" : "1",
"tanggal_revisi": "2018-06-28 01:10:04.205389+07",
"id_user": "12",
"nama_user": "Agus Budi"
}
]
},
"function": "tagihan/detail",
"status": "OK",
"msg": "Pengambilan Detail Tagihan Sukses",
"ts_req": "2018-06-20 01:10:04.205389+07",
"ts_resp": "2018-06-20 01:10:05.560817+07",
"req_id": "1870"
}

Mendapatkan Detail Tagihan berdasarkan Nomor Invoice

Field Wajib Diisi Keterangan
id_tagihan Ya ID tagihan di dalam sistem Smart Billing
id_institusi Ya ID Institusi Anda
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda
nomor_pembayaran Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
nama Informasi nama yang ingin ditagih
informasi Minimal diisi 1 set {‘label’ & ‘info’}. Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
rincian Minimal diisi 1 set {‘kode’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Nomor Invoice dari Institusi Anda
waktu_berlaku Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Waktu jatuh tempo.
waktu_kedaluwarsa Waktu kedaluwarsa.
email Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
id_pelanggan Nomor pelanggan di lingkungan internal Institusi Anda
klasifikasi Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi
label Informasi untuk label, bisa lebih dari satu label
revisi Nomor Revisi atas tagihan ini
daftar_revisi Berisi riwayat penambahan dan perubahan tagihan

Cari Tagihan

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan password Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"status_tagihan": "Menunggu Pemeriksaan",
"keyword": "coba BUDI",
"ts_start": "1970-01-01 00:00:00",
"ts_end": "2020-12-31 23:59:59",
"prefix": ["00", "01"],
"advance_search_profile": [
{"field": "nama", "operator": "=", "filter": "AHMAD YANTO"},
{"field": "nomor_invoice", "operator": "=", "filter": "167463523"},
],
"advance_search_informasi": [
{"field": "Info 1", "operator": "=", "filter": "Tagihan Semesteran"}
],
"advance_search_rincian": [
{"field": "001", "operator": "=", "filter": "200000"}
],
"klasifikasi" : [
{"id_klasifikasi": "12", "id_pilihan_klasifikasi": "22"},
{"id_klasifikasi": "123", "id_pilihan_klasifikasi": "12123"}
],
"order_by": [
{"field":"status_tagihan","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"offset": "0",
"limit": "20"
}' \
https://bayar.id/api/smartbilling/tagihan/cari
<?php
$url = "https://bayar.id/api/smartbilling/tagihan/cari";

$token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$arr_headers = array(
'API-Environment: trial',
'Authorization: Bearer ' . $token
);
$arr_payload = array (
'id_institusi' => '2373278237823782378',
'status_tagihan' => 'Menunggu Pemeriksaan',
'keyword' => 'coba BUDI',
'ts_start' => '1970-01-01 00:00:00',
'ts_end' => '2020-12-31 23:59:59',
'prefix' => array (
0 => '00',
1 => '01',
),
'advance_search_profile' => array(
array('field' => 'nama', 'operator' => '=', 'filter' => 'AHMAD YANTO'),
array('field' => 'nomor_invoice', 'operator' => '=', 'filter' => '167463523'),
),
'advance_search_informasi' => array(
array('field' => 'Info 1', 'operator' => '=', 'filter' => 'Tagihan Semesteran')
),
'advance_search_rincian' => array(
array('field' => '001', 'operator' => '=', 'filter' => '200000')
),
'klasifikasi' => array (
0 => array (
'id_klasifikasi' => '12',
'id_pilihan_klasifikasi' => '22',
),
1 => array (
'id_klasifikasi' => '123',
'id_pilihan_klasifikasi' => '12123',
),
),
'order_by' => array (
0 => array (
'field' => 'status_tagihan',
'direction' => 'ASC',
),
1 => array (
'field' => 'nama',
'direction' => 'DESC',
),
),
'offset' => '0',
'limit' => '20',
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url;
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $arr_headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arr_payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
echo $result;
?>

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_institusi":"2373278237823782378",
"id_tagihan": "ABC12321AA37\/TAG\/2017",
"revisi": "0",
"nomor_pembayaran": "0806444524",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"status_tagihan": "Menunggu Pemeriksaan",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01 00:00:00",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"judul": "Info1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
}
],
"email": "coba@coba.com",
"catatan": "",
"minimal_pembayaran": "0",
"nomor_hp": "08118880570",
"balance": "1500000",
"total_tagihan": "1500000",
"total_pembayaran": "0",
"status_tagihan": "Open",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
}
],
"function": "tagihan/cari",
"status": "OK",
"msg": "Pencarian 'coba.com GUAR' Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Mencari Tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
keyword Ya Kata Kunci yang akan anda cari
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda
nomor_pembayaran Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
id_pelanggan Nomor pelanggan di lingkungan internal Institusi Anda
nama Informasi nama yang ingin ditagih
informasi Minimal diisi 1 set {‘label’ & ‘info’}. Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
status_tagihan berisi status tagihan tsb. apakah “open” untuk jumlah pembayaran boleh tidak sama dengan total tagihan, dan “closed” untuk jumlah pembayaran harus sama dengan total tagihan
rincian Minimal diisi 1 set {‘kode’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Nomor Invoice dari Institusi Anda
status_approval Status Tagihan sudah approved atau belum
waktu_berlaku Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Waktu jatuh tempo.
waktu_kedaluwarsa Waktu kedaluwarsa.
total_nominal_tagihan Total nominal tagihan.
email Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
klasifikasi Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi

Rangkuman Tagihan

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan password Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"9ba2008fcc1eee643ddbe37e36f76492"
}' \
https://bayar.id/api/smartbilling/tagihan/summary

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"9ba2008fcc1eee643ddbe37e36f76492",
"batch_id": "119"
},
"function": "summary-tagihan",
"status": "OK",
"msg": "Lihat summary tagihan sukses",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Rangkuman tagihan dalam rentang waktu per biller, per channel, untuk total tagihan yang sudah dan belum dibayar.

Pada HTTP Request harus mengandung header-header sebagai berikut:

BayarID-API-Args: {"username":"XXXXX","password":"YYYYY"}
API-Environment: trial

Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Dan data di dalam payload HTML POST sebagai berikut:

{ "id_institusi":"2373278237823782378" }

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
Field Keterangan
id_institusi ID Institusi Anda

Histori Perubahan Tagihan

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan password Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378"
}' \
https://bayar.id/api/smartbilling/tagihan/change-log

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
}
},
"function": "change-log-tagihan",
"status": "OK",
"msg": "Histori Perubahan Tagihan Sukses",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Memperlihatkan kronologi perubahan data tagihan

Pada HTTP Request harus mengandung header-header sebagai berikut:

BayarID-API-Args: {"username":"XXXXX","password":"YYYYY"}
API-Environment: trial

Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Dan data di dalam payload HTML POST sebagai berikut:

{ "id_institusi":"2373278237823782378" }

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
id_tagihan Ya ID tagihan yang akan dilihat status perubahanya
Field Keterangan
id_institusi ID Institusi Anda
id_tagihan ID tagihan yang akan dilihat status perubahanya

Import Berkas

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"deskripsi_import":"Percobaan import ke 1",
"id_berkas": "161"
}' \
https://bayar.id/api/smartbilling/tagihan/import-berkas

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_proses": "231222",
"id_institusi":"2373278237823782378",
"deskripsi_import":"Percobaan import ke 1",
"id_berkas": "160",
"status_proses" : "Menunggu Pemrosesan"
},
"function": "tagihan/import-berkas",
"status": "OK",
"msg": "Sedang Menunggu Pemrosesan",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2287"
}

// Atau

{
"data": {
"id_proses": "50",
"id_institusi": "bf176f63d01190b8787f28cd6c5c1b40",
"deskripsi_import": "DESKRIPSI COBA COBA 123",
"id_berkas": "174",
"status_proses": "Menunggu Pemrosesan"
},
"function": "tagihan/import-berkas",
"status": "ERR-WAITING",
"msg": "Sedang Menunggu Pemrosesan",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2287"
}

Import tagihan dari berkas yang telah diungggah sebelumnya pada fungsi Berkas->Unggah Berkas

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
deskripsi_import Ya Catatan untuk batch yang di upload

POST Upload: (MAX 20MB) file (XLSX)

Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
deskripsi_batch Catatan untuk batch yang di upload

Status Proses Import Berkas

Silakan ganti XXXXX dengan token hasil Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_proses": "231222"
}' \
https://bayar.id/api/smartbilling/tagihan/status-import-berkas

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_proses": "231222",
"id_berkas": "161",
"jumlah_data_total": 1500,
"jumlah_data_sudah_diproses": 780,
"jumlah_data_tagihan_baru": 700,
"jumlah_data_tagihan_tanpa_perubahan": 75,
"jumlah_data_gagal_diproses": 5,
"ts_update": "2018-08-03 05:32:44.46121",
"status_proses": "Proses Ekstraksi",
"id_operator": "134",
"id_institusi": "7bb755717cbc0bfbb60b09e101f7cad9",
"deskripsi": "Percobaan import ke 1"
},
"function": "tagihan/status-import-berkas",
"status": "OK",
"msg": "Proses pendaftaran proses import berhasil",
"ts_req": "2018-08-03 05:35:22.468004+07",
"ts_resp": "2018-08-03 05:35:22.519995+07",
"req_id": "27511"
}

Melihat status Import Berkas Tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload

Array of upload-status

Buat Berkas Export Tagihan

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"deskripsi_export":"Percobaan export ke 1",
"tipe_berkas": "xls",
"keyword": "",
"status_tagihan": "Menunggu Pemeriksaan",
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"status_tagihan","direction":"ASC"},
{"field":"nama","direction":"DESC"}
]
}' \
https://bayar.id/api/smartbilling/tagihan/export-berkas

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_proses": "231222",
"id_berkas": "183",
"id_institusi":"2373278237823782378",
"deskripsi_export":"Percobaan export ke 1",
"status_proses" : "Menunggu Pemrosesan"
},
"function": "tagihan/export-berkas",
"status": "OK",
"msg": "Sedang Menunggu Pemrosesan",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2287"
}

Export tagihan akan bisa diunduh pada fungsi Berkas->Unduh Berkas

[TBD]

[TBD]

Status Proses Export Berkas

Silakan ganti XXXXX dengan token hasil Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_proses": "231222"
}' \
https://bayar.id/api/smartbilling/tagihan/status-export-berkas

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_proses": "231222",
"id_berkas": "161",
"jumlah_data_total": 1500,
"ts_update": "2018-08-03 05:32:44.46121",
"status_proses": "Proses Export",
"id_operator": "134",
"id_institusi": "7bb755717cbc0bfbb60b09e101f7cad9",
"deskripsi_export": "Percobaan export ke 1"
},
"function": "tagihan/status-export-berkas",
"status": "OK",
"msg": "Proses pendaftaran proses export berhasil",
"ts_req": "2018-08-03 05:35:22.468004+07",
"ts_resp": "2018-08-03 05:35:22.519995+07",
"req_id": "27511"
}

Melihat status Export Berkas Tagihan

[TBD]

[TBD]

List Kode Akun

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan password Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
}' \
https://bayar.id/api/smartbilling/tagihan/list-kode-akun

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
"Listrik",
"Air"
],
"function": "tagihan/list-kode-akun",
"status": "OK",
"msg": "List kode Akun Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

List Kode Akun

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda

Kirim Notifikasi

Silakan ganti XXXXX dengan token hasil otentikasi Anda

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_tagihan": ["230","241"],
"id_institusi":"2373278237823782378",
"template" : "default"
}' \
https://bayar.id/api/smartbilling/tagihan/kirim-notifikasi

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_tagihan": ["230","241"],
"id_institusi":"2373278237823782378",
"template" : "default"
},
"function": "tagihan/kirim-notifikasi",
"status": "OK",
"msg": "Kirim Notifikasi Tagihan Sukses",
"ts_req": "2018-06-20 01:10:04.205389+07",
"ts_resp": "2018-06-20 01:10:05.560817+07",
"req_id": "1889"
}

Kirim notifikasi Tagihan

TBD

TBD

Klasifikasi Tagihan

Membuat Klasifikasi

Silakan ganti XXXXX dengan token hasil otentikasi

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"kode_klasifikasi":"FAK",
"nama_klasifikasi":"Fakultas",
"status_klasifikasi": "Aktif",
"pilihan_klasifikasi": [
{
"nama_pilihan_klasifikasi": "Teknik",
"status_pilihan_klasifikasi": "Aktif"
},
{
"nama_pilihan_klasifikasi": "Ekonomi",
"status_pilihan_klasifikasi": "Non Aktif"
}
]
}' \
https://bayar.id/api/smartbilling/klasifikasi-tagihan/tambah

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_klasifikasi":"37",
"id_institusi":"2373278237823782378",
"kode_klasifikasi":"FAK",
"nama_klasifikasi":"Fakultas",
"status_klasifikasi": "Aktif",
"id_pilihan_klasifikasi_default": "23",
"pilihan_klasifikasi": [
{
"id_pilihan_klasifikasi" : "23",
"nama_pilihan_klasifikasi": "Teknik",
"status_pilihan_klasifikasi": "Aktif"
},
{
"id_pilihan_klasifikasi" : "24",
"nama_pilihan_klasifikasi": "Ekonomi",
"status_pilihan_klasifikasi": "Non Aktif"
}
]
},
"function": "klasifikasi-tagihan/tambah",
"status": "OK",
"msg": "Upload Batch 'coba upload ke 1' 80%",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Membuat Klasifikasi tagihan baru

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
kode_klasifikasi Ya Kode unik setiap klasifikasi
nama_klasifikasi Ya Nama/deskripsi singkat dari tiap kode_klasifikasi
pilihan_klasifikasi Ya Merupakan array of String
Field Keterangan
id_klasifikasi ID Klasifikasi Anda
id_institusi ID Institusi Anda
kode_klasifikasi Kode unik setiap klasifikasi
nama_klasifikasi Nama/deskripsi singkat dari tiap kode_klasifikasi
pilihan_klasifikasi Merupakan array of String

Mengubah Item & Klasifikasi

Silakan ganti XXXXX dengan token hasil otentikasi

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_klasifikasi": "37",
"id_institusi":"2373278237823782378",
"kode_klasifikasi":"U101",
"nama_klasifikasi":"Utilities",
"status_klasifikasi": "Aktif",
"id_pilihan_klasifikasi_default": "23",
"pilihan_klasifikasi": [
{
"id_pilihan_klasifikasi": "22",
"nama_pilihan_klasifikasi": "Listrik",
"status_pilihan_klasifikasi": "Aktif"
},
{
"id_pilihan_klasifikasi": "23",
"nama_pilihan_klasifikasi": "Air",
"status_pilihan_klasifikasi": "Non Aktif"
}
]
}' \
https://bayar.id/api/smartbilling/klasifikasi-tagihan/ubah

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_klasifikasi": "37",
"id_institusi":"2373278237823782378",
"kode_klasifikasi":"U101",
"nama_klasifikasi":"Utilities",
"status_klasifikasi": "Aktif",
"id_pilihan_klasifikasi_default": "23",
"pilihan_klasifikasi": [
{
"id_pilihan_klasifikasi": "22",
"nama_pilihan_klasifikasi": "Listrik",
"status_pilihan_klasifikasi": "Aktif"
},
{
"id_pilihan_klasifikasi": "23",
"nama_pilihan_klasifikasi": "Air",
"status_pilihan_klasifikasi": "Non Aktif"
}
]
},
"function": "klasifikasi-tagihan/ubah",
"status": "OK",
"msg": "Update klasifikasi berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Mengubah Item & Klasifikasi tagihan

Field Wajib Diisi Keterangan
id_klasifikasi Ya ID Klasifikasi Anda
id_institusi Ya ID Institusi Anda
kode_klasifikasi Ya Kode unik setiap klasifikasi
nama_klasifikasi Ya Nama/deskripsi singkat dari tiap kode_klasifikasi
pilihan_klasifikasi Ya Merupakan array of String
Field Keterangan
id_klasifikasi ID Klasifikasi Anda
id_institusi ID Institusi Anda
kode_klasifikasi Kode unik setiap klasifikasi
nama_klasifikasi Nama/deskripsi singkat dari tiap kode_klasifikasi
pilihan_klasifikasi Merupakan array of [id_pilihan_klasifikasi, item_klasifikasi]

Menambah Item Klasifikasi

Silakan ganti XXXXX dengan token hasil otentikasi

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_klasifikasi": "37",
"id_institusi":"2373278237823782378",
"nama_pilihan_klasifikasi": "Listrik",
"status_pilihan_klasifikasi": "Aktif"
}' \
https://bayar.id/api/smartbilling/klasifikasi-tagihan/tambah-item

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_klasifikasi": "37",
"id_institusi":"2373278237823782378",
"nama_pilihan_klasifikasi": "Listrik",
"status_pilihan_klasifikasi": "Aktif",
"id_pilihan_klasifikasi": "443"
},
"function": "klasifikasi-tagihan/tambah-item",
"status": "OK",
"msg": "Update Item klasifikasi berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Menambah Item Klasifikasi tagihan

Field Wajib Diisi Keterangan
id_klasifikasi Ya ID Klasifikasi Anda
id_institusi Ya ID Institusi Anda
nama_pilihan_klasifikasi Ya Merupakan nama pilihan klasifikasi yang ingin ditambah (array of String)
Field Keterangan
id_klasifikasi ID Klasifikasi Anda
id_institusi ID Institusi Anda
nama_pilihan_klasifikasi Merupakan nama pilihan klasifikasi yang baru ditambah
id_pilihan_klasifikasi Merupakan ID pilihan klasifikasi yang dibuat secara otomatis (array of String)

List Klasifikasi

Silakan ganti XXXXX dengan token hasil otentikasi

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "2373278237823782378",
"status_klasifikasi": "Aktif",
"status_pilihan_klasifikasi": "Aktif"
}' \
https://bayar.id/api/smartbilling/klasifikasi-tagihan/list

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_klasifikasi": "37",
"id_institusi":"2373278237823782378",
"kode_klasifikasi":"U101",
"nama_klasifikasi":"Utilities",
"status_klasifikasi": "Aktif",
"pilihan_klasifikasi": [
{
"id_pilihan_klasifikasi": "22",
"nama_pilihan_klasifikasi": "Listrik",
"status_pilihan_klasifikasi": "Aktif"
},
{
"id_pilihan_klasifikasi": "23",
"nama_pilihan_klasifikasi": "Air",
"status_pilihan_klasifikasi": "Non Aktif"
}
]
},
{
"id_klasifikasi": "38",
"id_institusi":"2373278237823782378",
"kode_klasifikasi":"PRD",
"nama_klasifikasi":"PERIODE",
"status_klasifikasi": "Aktif",
"pilihan_klasifikasi": [
{
"id_pilihan_klasifikasi": "380",
"nama_pilihan_klasifikasi": "Januari 2018",
"status_pilihan_klasifikasi": "Aktif"
},
{
"id_pilihan_klasifikasi": "381",
"nama_pilihan_klasifikasi": "Februari 2018",
"status_pilihan_klasifikasi": "Aktif"
},
{
"id_pilihan_klasifikasi": "382",
"nama_pilihan_klasifikasi": "Maret 2018",
"status_pilihan_klasifikasi": "Aktif"
},
{
"id_pilihan_klasifikasi": "380",
"nama_pilihan_klasifikasi": "April 2018",
"status_pilihan_klasifikasi": "Aktif"
}
]
}
],
"function": "klasifikasi-tagihan-list",
"status": "OK",
"msg": "Update klasifikasi berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

List klasifikasi tagihan yang sudah ada

Field Wajib Diisi Keterangan
id_klasifikasi Ya ID Klasifikasi Anda
Field Keterangan
id_klasifikasi ID Klasifikasi Anda
id_institusi ID Institusi Anda
kode_klasifikasi Kode unik setiap klasifikasi
nama_klasifikasi Nama/deskripsi singkat dari tiap kode_klasifikasi
pilihan_klasifikasi Merupakan array of String

Label Tagihan

List Label [OK]

Silakan ganti XXXXX dengan token hasil otentikasi

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378"
}' \
https://bayar.id/api/smartbilling/label-tagihan/list

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"label": [
"Pak Agus",
"Medan"
]
},
"function": "label-tagihan/list",
"status": "OK",
"msg": "List Label berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

List Label tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
Field Keterangan
label Array of Label

Support

Membuat Tiket

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"subject":"Subject Pertanyaan",
"description":"Deskripsi & rincian pertanyaan",
"level":"Medium",
"tipe":"Support"
}' \
https://bayar.id/api/smartbilling/support/buat-tiket
-F 'file=@berkas_pendukung.pdf'

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_tiket": "056",
"id_institusi":"2373278237823782378",
"subject":"Subject Pertanyaan",
"description":"Deskripsi & rincian pertanyaan",
"level":"Medium",
"tipe":"Support"
},
"function": "support/buat-tiket",
"status": "OK",
"msg": "Submit Support Ticket Sukses",
"ts_req": "2018-06-15 03:40:52.376761+07",
"ts_resp": "2018-06-15 03:40:52.631537+07",
"req_id": "1053"
}

Membuat tiket, beserta dengan file-file pendukungnya

Field Wajib Diisi Keterangan
subject Ya Subject tiket yang akan dibuat
description Ya Deskripsi / detail dari tiket yang dibuat
level Ya Level tingkat kepentingan dari tiket yang dibuat. options: [ Low / Medium / High ]
Tipe Ya Tipe tiket yang dibut. options: [ Billing / Info / Support / Sales ]

POST upload: (MAX 16MB) file

Field Keterangan
id_tiket nomor ID dari tiket yang dibuat
subject Subject tiket yang akan dibuat
description Deskripsi / detail dari tiket yang dibuat
level Level tingkat kepentingan dari tiket yang dibuat. options: [ Low / Medium / High ]
Tipe Tipe tiket yang dibuat. options: [ Billing / Info / Support / Sales ]

List Tiket

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"jml_tiket_terakhir":"5"

}' \
https://bayar.id/api/smartbilling/support/lihat-daftar-tiket

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"jml_tiket_terakhir":"5",
"tiket" : [
{
"id_tiket": "56",
"id_institusi":"2373278237823782378",
"subject":"Subject Pertanyaan",
"description":"Deskripsi & rincian pertanyaan",
"level":"Medium",
"tipe":"Support"
},
{
"id_tiket": "55",
"id_institusi":"2373278237823782378",
"subject":"Subject XXX",
"description":"Deskripsi & rincian XXX",
"level":"High",
"tipe":"Support"
}
]
},
"function": "support/lihat-daftar-tiket",
"status": "OK",
"msg": "Submit Lihat Daftar Tiket Sukses",
"ts_req": "2018-06-15 03:40:52.376761+07",
"ts_resp": "2018-06-15 03:40:52.631537+07",
"req_id": "1053"
}

Melihat seluruh tiket yang dimiliki (diajukan)

Pada HTTP Request harus mengandung header-header sebagai berikut:

BayarID-API-Args: {"username":"XXXXX","password":"YYYYY"}
API-Environment: trial

Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Dan data di dalam payload HTML POST sebagai berikut:

{ "jml_ticket_terakhir":"5" }

Field Wajib Diisi Keterangan
jml_tiket_terakhir Ya Jumlah tiket terakhir yang masuk
Field Keterangan
jml_tiket_terakhir Jumlah tiket terakhir yang masuk
id_tiket nomor ID tiket
subject Subject tiket
description Deskripsi / detail dari tiket
level Level tingkat kepentingan dari tiket. options: [ Low / Medium / High ]
Tipe Tipe tiket. options: [ Billing / Info / Support / Sales ]

Ubah Tiket

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_tiket": "56",
"id_institusi":"2373278237823782378",
"tambahan_catatan":"Deskripsi & rincian pertanyaan",
"level":"Medium",
"tipe":"Support"
}' \
https://bayar.id/api/smartbilling/support/ubah-tiket

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_tiket": "56",
"id_institusi":"2373278237823782378",
"tambahan_catatan":"Deskripsi & rincian pertanyaan",
"level":"Medium",
"tipe":"Support"
},
"function": "support/ubah-tiket",
"status": "OK",
"msg": "Ubah Tiket Sukses",
"ts_req": "2018-06-17 07:58:42.119136+07",
"ts_resp": "2018-06-17 07:58:42.496685+07",
"req_id": "1238"
}

Menambahkan conversation dan pengubahan status tiket

Field Wajib Diisi Keterangan
id_tiket Ya Nomor ID tiket
update_notes Ya Catatan yang diubah/tambahkan
update_description ?
update_status Ya Status tiket yang diubah, yaitu: Closed / Open
update_level_support Tidak Level support yang diberikan untuk tiket tsv. Range nya: 1 s/d 5

POST upload: (MAX 16 MB) file

Field Keterangan
id_tiket Nomor ID tiket
update_notes Catatan yang diubah/tambahkan
update_description ?
update_status Status tiket yang diubah, yaitu: Closed / Open
update_level_support Level support yang diberikan untuk tiket tsv. Range nya: 1 s/d 5

Detail Tiket

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'API-Function: support-ticket-details' \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_tiket":"12"

}' \
https://bayar.id/api/smartbilling/

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"issue": {
"id": 12,
"project": {
"id": 2,
"name": "Support Bayar.ID (DEV)"
},
"tracker": {
"id": 3,
"name": "Support"
},
"status": {
"id": 1,
"name": "New"
},
"priority": {
"id": 2,
"name": "Normal"
},
"author": {
"id": 9,
"name": "Guar 199"
},
"subject": "Coba Coba",
"description": "COBA AJA 2",
"start_date": "2018-06-17",
"done_ratio": 0,
"created_on": "2018-06-16T21:37:25Z",
"updated_on": "2018-06-16T22:15:26Z",
"attachments": [
{
"id": 1,
"filename": "untitled.pdf",
"filesize": 1206240,
"content_type": "application\/octet-stream",
"description": "Attachment Coba Coba",
"content_url": "https:\/\/bayar.id\/api\/smartbilling\/external\/?f=support-attachment&key=ab0304e617364a5fd823ab95a0ec4545b53e1818&exp=1529195046.5391&file=http:\/\/support.bayar.id\/attachments\/download\/1\/untitled.pdf&name=untitled.pdf&type=application%2Foctet-stream",
"author": {
"id": 9,
"name": "Guar 199"
},
"created_on": "2018-06-16T21:37:25Z"
},
{
"id": 2,
"filename": "02. Intro to Framework, Server Side Programming with Django.pdf",
"filesize": 866758,
"content_type": "application\/pdf",
"description": "",
"content_url": "https:\/\/bayar.id\/api\/smartbilling\/external\/?f=support-attachment&key=b132bc2796c88d916ddc5fd3915352373bd9c6b0&exp=1529195046.5392&file=http:\/\/support.bayar.id\/attachments\/download\/2\/02.%20Intro%20to%20Framework,%20Server%20Side%20Programming%20with%20Django.pdf&name=02.+Intro+to+Framework%2C+Server+Side+Programming+with+Django.pdf&type=application%2Fpdf",
"author": {
"id": 5,
"name": "Service Bayar.ID"
},
"created_on": "2018-06-16T22:15:24Z"
}
],
"journals": [
{
"id": 1,
"user": {
"id": 5,
"name": "Service Bayar.ID"
},
"notes": "asdasda",
"created_on": "2018-06-16T22:15:26Z",
"details": [
{
"property": "attachment",
"name": "2",
"new_value": "02. Intro to Framework, Server Side Programming with Django.pdf"
}
]
}
]
}
},
"function": "support-ticket-details",
"status": "OK",
"msg": "Submit Support Ticket Sukses",
"ts_req": "2018-06-17 07:14:06.430057+07",
"ts_resp": "2018-06-17 07:14:06.539542+07",
"req_id": "1198"
}

Melihat tiket (dan update seluruh conversation) berdasarkan ID ticket

Field Wajib Diisi Keterangan
id_tiket Ya Nomor ID tiket
Field Keterangan
id Nomor ID tiket
project ?
subject Subject tiket
desription Deskripsi singkat tiket
start_date ? Tanggal mulainya tiket di follow up
done_ratio Lamanya hari penyelesaian tiket
created_on Tanggal dibuatnya tiket
updated_on Tanggal terakhir status tiket diupdate
attachments Lampiran tiket

Detail Tiket

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"nommor_pembayaran":"123456",
"kode_bpi":"5050",
"kode_bank":"BNI",
"kode_channel":"MBANK",
}' \
https://bayar.id/api/smartbilling/support/cara-bayar

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"proses": [
"1. Pilih menu transfer",
"2. Pilih Transfer antar bank",
"3. Pilih rekening tujuan dengan Bank Syariah Indonesia Masukkan nomor rekening tujuan dengan nomor rekening 9001212121212",
"4. Masukkan Nominal Uang yang akan ditransfer",
"5. Isi email, deskripsi klik Lanjut.",
"6. Kemudian akan tampil informasi data transaksi anda, Validasi dengan memasukan pasword lalu klik tombol lanjut.",
"7. Jika berhasil maka akan keluar bukti transaksi"
]
},
"function": "support/cara-bayar",
"status": "OK",
"msg": "Lihat Cara Pembayaran MBANK BNI Sukses",
"ts_req": "2018-06-17 07:14:06.430057+07",
"ts_resp": "2018-06-17 07:14:06.539542+07",
"req_id": "1198"
}

Melihat cara pembayaran dinamis sesuai nomor bayar yang diinputkan.

Field Wajib Diisi Keterangan
nomor_pembayaran Ya Nomor pembayaran tagihan
kode_bpi Ya Kode BPI institusi yang memiliki tagihan tersebut
kode_bank Ya Pembayaran melalui bank (BSI, BNI, MANDIRI, BCA, BRI) yang dipilih
kode_channel Ya Pembayaran melalui channel (ATM, TELLER, MBANK, IBANK) yang dipilih
Field Keterangan
proses Langkah - langkah proses yang dilakukan nasabah untuk membayar tagihan

Transaksi

Inquiry

Silakan ganti XXXXX dengan token Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"inquiry_request_id": "19933388211",
"kode_terminal":"SJB2211",
"kode_cabang":"KCP Jogja",
"kode_operator":"OPR008"
}' \
https://bayar.id/api/smartbilling/transaksi/inquiry

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data":
{
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"inquiry_request_id": "19933388211",
"kode_terminal":"SJB2211",
"kode_cabang":"KCP Jogja",
"kode_operator":"OPR008",
"nama_institusi":"Perusahaan ABC",
"id_tagihan" : ["444"],
"revisi" : "0",
"nomor_invoice": ["ABC12321AA37/TAG/2017"],
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kadaluarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Pembayaran",
"status_pembayaran" : null
}
,
"function": "transaksi/inquiry",
"status": "OK",
"msg": "Inquiry berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Mengambil data tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload
model Ya Dapat diisi dengan “satuan-tagihan-valid”, “akumulasi-tagihan-valid”
Field Keterangan
id_institusi ID Institusi Anda

Payment

Silakan ganti XXXXX dengan token Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"payment_request_id": "19933388211",
"kode_terminal":"SJB2211",
"kode_cabang":"KCP Jogja",
"total_nominal_pembayaran": 1500000,
"kode_operator":"OPR008",
"id_tagihan" : "444",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"catatan": "Ini percobaan 1",
"kode_unik_transaksi_bank": "23234234234234",
"kode_jurnal_bank": "23234234234234",
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
]
}' \
https://bayar.id/api/smartbilling/transaksi/payment

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"payment_request_id": "19933388211",
"kode_terminal":"SJB2211",
"kode_cabang":"KCP Jogja",
"total_nominal_pembayaran": 1500000,
"kode_operator":"OPR008",
"nama_institusi":"Perusahaan ABC",
"id_tagihan" : "444",
"revisi" : "1",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kadaluarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode_akun": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode_akun": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Terbayar",
"status_pembayaran" : "Menunggu Validasi",
"id_transaksi" : "76152"
}
},
"function": "transaksi/payment",
"status": "OK",
"msg": "Payment berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Membayar tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload
rincian Tidak Rincian detil transaksi
Field Keterangan
id_institusi ID Institusi Anda

Reversal

Silakan ganti XXXXX dengan token Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:30",
"waktu_transaksi_pembayaran":"2018-01-01 09:10:20",
"payment_request_id": "19933388211",
"reversal_request_id": "19933388215",
"kode_unik_transaksi_bank": "23234234234234",
"kode_jurnal_bank": "23234234234234",
"total_nominal_pembayaran": 1500000
}' \
https://bayar.id/api/smartbilling/transaksi/reversal

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"payment_request_id": "19933388211",
"reversal_request_id": "19933388215",
"kode_terminal":"SJB2211",
"kode_cabang":"KCP Jogja",
"kode_operator":"OPR008",
"nama_institusi":"Perusahaan ABC",
"id_tagihan" : "444",
"revisi" : "1",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kadaluarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Menunggu Pembayaran",
"status_pembayaran" : "Dibatalkan"
}
},
"function": "transaksi/reversal",
"status": "OK",
"msg": "Reversal berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Reversal tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload
Field Keterangan
id_institusi ID Institusi Anda

Ping

Silakan ganti XXXXX dengan token Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"kode_bpi":"8033"
}' \
https://bayar.id/api/smartbilling/transaksi/reversal

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"kode_bpi":"8033"
}
},
"function": "transaksi/ping",
"status": "OK",
"msg": "Ping berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Ping

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload
Field Keterangan
id_institusi ID Institusi Anda

Advice

Silakan ganti XXXXX dengan token Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"advice_request_id": "19933388218"
}' \
https://bayar.id/api/smartbilling/transaksi/reversal

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"payment_request_id": "19933388211",
"kode_terminal":"SJB2211",
"kode_cabang":"KCP Jogja",
"kode_operator":"OPR008",
"nama_institusi":"Perusahaan ABC",
"id_tagihan" : "444",
"revisi" : "1",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kadaluarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Terbayar",
"status_pembayaran" : "Menunggu Validasi"
}
},
"function": "transaksi/advice",
"status": "OK",
"msg": "Advice berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Advice tagihan yaitu mengambil seluruh informasi pembayaran sukses yang telah terjadi sebelumnya atas suatu nomor pembayaran.

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload
Field Keterangan
id_institusi ID Institusi Anda

Jurnal

Silakan ganti XXXXX dengan token Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"jurnal_request_id": "19933388218",
"payment_request_id": "19933388211"
}' \
https://bayar.id/api/smartbilling/transaksi/reversal

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"kode_bpi":"8033",
"nomor_pembayaran":"6666234234234",
"kode_bank":"BSM",
"kode_channel":"ATM",
"waktu_transaksi":"2018-01-01 09:10:20",
"jurnal_request_id": "19933388218",
"payment_request_id": "19933388211",
"kode_terminal":"SJB2211",
"kode_cabang":"KCP Jogja",
"kode_operator":"OPR008",
"nama_institusi":"Perusahaan ABC",
"id_tagihan" : "444",
"revisi" : "2",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kadaluarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan 1",
"id_pelanggan":"0806444524",
"informasi": [
{
"judul": "Info 1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
},
{
"judul": "Info 2",
"isi": "Semester Genap 2018",
"tipe": "inq_pay"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"id_pilihan_klasifikasi": "1"
},
{
"id_klasifikasi": "171",
"id_pilihan_klasifikasi": "2"
}
],
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Pak Agus", "Medan"],
"status_tagihan" : "Terbayar",
"status_pembayaran" : "Sukses"
}
},
"function": "transaksi/advice",
"status": "OK",
"msg": "Advice berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Advice tagihan yaitu mengambil seluruh informasi pembayaran sukses yang telah terjadi sebelumnya atas suatu nomor pembayaran.

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload
Field Keterangan
id_institusi ID Institusi Anda

List Transaksi

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan password Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"status_tagihan": "Menunggu Pemeriksaan",
"keyword": "coba BUDI",
"prefix": ["00", "01"],
"tanggal_awal": "2020-01-01 00:00:00",
"tanggal_akhir": "2020-12-31 23:59:59",
"klasifikasi" : [
{"id_klasifikasi": "12", "id_pilihan_klasifikasi": "22"},
{"id_klasifikasi": "123", "id_pilihan_klasifikasi": "12123"}
],
"order_by": [
{"field":"status_tagihan","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"offset": "0",
"limit": "20"
}' \
https://bayar.id/api/smartbilling/transaksi/list

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_record_pembayaran":"2373278237823782378",
"id_institusi":"2373278237823782378",
"nomor_invoice": "ABC12321AA37\/TAG\/2017",
"revisi": "0",
"waktu_transaksi": "2018-11-21 11:23:42",
"nomor_panggil_pembayaran": "0806444524",
"kode_unik_transaksi_bank": "73166162312343534",
"waktu_transaksi_bank": "2018-11-21 11:22:55",
"kode_bank": "BSM",
"kanal_bayar_bank": "TELLER",
"kode_terminal_bank": "TERM00012",
"total_nominal_pembayaran": "1500000",
"status_pembayaran": "Terbayar",
"billref": "Ohtheebee2zea1choox7egh5nohvoomee0Oogie2",
"metode_pembayaran": "Host2Host",
"catatan": "",
"id_operator": "bsm002",
"kode_unik_transaksi_switching": "payment-PaiwohvooPheeSu6ohy0eeg4ap2zieVe6eileghu",
"kode_jurnal_bank": "ABBL727615533/FT0072765155321243",
"kode_unik_reversal_bank": "",
"kode_unik_reversal_switching": "",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01 00:00:00",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"judul": "Info1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
}
],
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570",
"balance": "0",
"total_tagihan": "1500000",
"total_pembayaran": "1500000",
"status_tagihan": "Closed",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
}
],
"function": "transaksi/list",
"status": "OK",
"msg": "Pencarian Transaksi 'coba.com GUAR' Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

List Transaksi

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
keyword Ya Kata Kunci yang akan anda cari
Field Keterangan

[TBD]

History Transaksi

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan password Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"status_transaksi": "Menunggu Pemeriksaan",
"nomor_pembayaran": "123123123",
"prefix": ["00", "01"],
"tanggal_awal": "2020-01-01 00:00:00",
"tanggal_akhir": "2020-12-31 23:59:59",
"order_by": [
{"field":"status_tagihan","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"offset": "0",
"limit": "20"
}' \
https://bayar.id/api/smartbilling/transaksi/history

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_record_pembayaran":"2373278237823782378",
"id_institusi":"2373278237823782378",
"nomor_invoice": "ABC12321AA37\/TAG\/2017",
"revisi": "0",
"waktu_transaksi": "2018-11-21 11:23:42",
"nomor_panggil_pembayaran": "0806444524",
"kode_unik_transaksi_bank": "73166162312343534",
"waktu_transaksi_bank": "2018-11-21 11:22:55",
"kode_bank": "BSM",
"kanal_bayar_bank": "TELLER",
"kode_terminal_bank": "TERM00012",
"total_nominal_pembayaran": "1500000",
"status_pembayaran": "Terbayar",
"billref": "Ohtheebee2zea1choox7egh5nohvoomee0Oogie2",
"metode_pembayaran": "Host2Host",
"catatan": "",
"id_operator": "bsm002",
"kode_unik_transaksi_switching": "payment-PaiwohvooPheeSu6ohy0eeg4ap2zieVe6eileghu",
"kode_jurnal_bank": "ABBL727615533/FT0072765155321243",
"kode_unik_reversal_bank": "",
"kode_unik_reversal_switching": "",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01 00:00:00",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"judul": "Info1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
}
],
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570",
"balance": "0",
"total_tagihan": "1500000",
"total_pembayaran": "1500000",
"status_transaksi": "Sukses",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
]
}
],
"function": "transaksi/history",
"status": "OK",
"msg": "History Transaksi Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

History Transaksi

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
keyword Ya Kata Kunci yang akan anda cari
Field Keterangan

[TBD]

Riwayat

Revisi Data

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_entitas":"12",
"nama_entitas":"tagihan",
"offset":"0",
"limit":"20"
}' \
https://bayar.id/api/smartbilling/riwayat/revisi

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_entitas":"12",
"nama_entitas":"tagihan",
"offset":"0",
"limit":"2",
"jumlah_data_tersimpan": "3997",
"riwayat": [
{
"id_institusi":"2373278237823782378",
"id_tagihan": "ABC12321AA37\/TAG\/2017",
"revisi": "0",
"nomor_pembayaran": "0806444524",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"status_approval": "Approved",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kadaluarsa": "2020-01-01 00:00:00",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"label": "Info1",
"info": "Bayar Kuliah"
}
],
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570",
"balance": "1500000",
"total_tagihan": "1500000",
"total_pembayaran": "0",
"status_tagihan": "Open",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
"waktu_riwayat": "2018-01-01 20:22:12",
"aksi": "Update",
"id_operator": "123",
"nama_operator" : "Ahmad Bustomi"
},
{
"id_institusi":"2373278237823782378",
"id_tagihan": "ABC12321AA37\/TAG\/2017",
"revisi": "0",
"nomor_pembayaran": "0806444524",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"status_approval": "Approved",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kadaluarsa": "2020-01-01 00:00:00",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"label": "Info1",
"info": "Bayar Kuliah"
}
],
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570",
"balance": "1500000",
"total_tagihan": "1500000",
"total_pembayaran": "0",
"status_tagihan": "Open",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
"waktu_riwayat": "2018-01-01 20:22:12",
"aksi": "Update",
"id_operator": "123",
"nama_operator" : "Ahmad Bustomi"
}
]
},
"function": "riwayat/revisi",
"status": "OK",
"msg": "Inquiry berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

Mengambil data tagihan

Pada HTTP Request harus mengandung header-header sebagai berikut:

BayarID-API-Args: {"username":"XXXXX","password":"YYYYY"}
API-Environment: trial

Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Dan data di dalam payload HTML POST sebagai berikut:

{ "id_institusi":"2373278237823782378" }

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload
Field Keterangan
id_institusi ID Institusi Anda

Berkas

Tagihan

Unggah Berkas

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X PUT \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Filename: nama_berkas.xlsx' \
--upload-file {berkas_yang_ingin_diupload} \
https://bayar.id/api/smartbilling/berkas/unggah/{id_institusi}

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_berkas": "161",
"nama_berkas": "nama_berkas.xls",
"lokasi_berkas": "2018/08/02/guar199@gmail.com-2018-08-02-04-37-06.153315942604209200",
"metadata_berkas": "application/octet-stream; charset=binary",
"ukuran_berkas": "5878",
"sha1": "14dd58f554660a50f8571f87d281e205ff9e5eb3"
},
"function": "berkas/unggah",
"status": "OK",
"msg": "Upload berkas Sukses",
"ts_req": "2018-08-02 04:39:48.41592+07",
"ts_resp": "2018-08-02 04:39:48.474816+07",
"req_id": "27178"
}

Mengunggah berkas

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload
Field Keterangan
id_institusi ID Institusi Anda

List Proses Unggah Berkas

Silakan ganti XXXXX dengan token hasil Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378"
}' \
https://bayar.id/api/smartbilling/berkas/list-unggah

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_proses": "231222",
"deskripsi_import" : "Upload tagihan SEPENTIN revisi 14_04_2019.xlsx Sat Apr 20 2019 02:26:31 GMT+0700 (Western Indonesia Time)",
"status_proses" : "Menunggu Pemrosesan",
"waktu_upload" : "2019-04-20 02:26:31.013123",
"nama_berkas" : "SEPENTIN revisi 14_04_2019.xlsx",
"persentase_progress" : 0
},
{
"id_proses": "231223",
"deskripsi_import" : "Upload tagihan Coba.xlsx Sat Apr 20 2019 02:26:31 GMT+0700 (Western Indonesia Time)",
"status_proses" : "Menunggu Pemrosesan",
"waktu_upload" : "2019-04-20 02:26:31.013123",
"nama_berkas" : "Coba.xlsx",
"persentase_progress" : 0
},
{
"id_proses": "231224",
"deskripsi_import" : "Upload tagihan Coba2.xlsx Sat Apr 20 2019 02:26:31 GMT+0700 (Western Indonesia Time)",
"status_proses" : "Selesai Pemrosesan",
"waktu_upload" : "2019-04-20 02:26:31.013123",
"nama_berkas" : "Coba2.xlsx",
"persentase_progress" : 100
}
],
"function": "berkas/list-unggah",
"status": "OK",
"msg": "Proses import 33%",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

List status proses Import Berkas Tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload

Array of upload-status

Unduh Berkas

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X GET \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
https://bayar.id/api/smartbilling/berkas/unduh/{id_berkas}/{id_institusi}

Script di atas akan mengembalikan HTTP Redirect menuju berkas yang dimaksud

{
"data": {
"download_url": "https://bayar.id/berkas/2018/08/02/guar199@gmail.com-2018-08-02-10-28-05.153322368503924900?md5=bo43yalb7SWsX824FwRMiw&expires=1533223891",
"metadata_berkas": "application/octet-stream; charset=binary",
"nama_berkas": "Coba.xls",
"ukuran_berkas": "9216"
},
"function": "berkas/unduh",
"status": "OK",
"msg": "URL Download dapat digunakan untuk waktu 120 detik.",
"ts_req": "2018-08-02 22:29:31.158955+07",
"ts_resp": "2018-08-02 22:29:31.205435+07",
"req_id": "27401"
}

Mengunduh berkas

{id_proses_berkas} contoh: Soubae5uo1jahrue2sheequaifiechu8ohngeibu

Field Keterangan
id_institusi ID Institusi Anda

List Proses Unduh Berkas

Silakan ganti XXXXX dengan token hasil Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378"
}' \
https://bayar.id/api/smartbilling/berkas/list-unduh

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_proses": "231222",
"id_berkas": "183",
"deskripsi_export" : "Export tagihan export1.xlsx Sat Apr 20 2019 02:26:31 GMT+0700 (Western Indonesia Time)",
"status_proses" : "Menunggu Pemrosesan",
"waktu_proses" : "2019-04-20 02:26:31.013123",
"nama_berkas" : "export1.xlsx",
},
{
"id_proses": "231223",
"id_berkas": "184",
"deskripsi_export" : "Export tagihan coba.xlsx Sat Apr 20 2019 02:26:31 GMT+0700 (Western Indonesia Time)",
"status_proses" : "Menunggu Pemrosesan",
"waktu_proses" : "2019-04-20 02:26:31.013123",
"nama_berkas" : "coba.xlsx",
},
{
"id_proses": "231224",
"id_berkas": "185",
"deskripsi_export" : "Export tagihan coba2.xlsx Sat Apr 20 2019 02:26:31 GMT+0700 (Western Indonesia Time)",
"status_proses" : "Selesai Pemrosesan",
"waktu_proses" : "2019-04-20 02:26:31.013123",
"nama_berkas" : "coba2.xlsx",
}
],
"function": "berkas/list-unduh",
"status": "OK",
"msg": "Proses export 33%",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

List status proses Export Berkas Tagihan

[TBD]

[TBD]

Hapus Berkas

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X DELETE \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
https://bayar.id/api/smartbilling/berkas/hapus/{id_berkas}/{id_institusi}

Script di atas akan mengembalikan HTTP Redirect menuju berkas yang dimaksud

{
"data": null,
"function": "berkas\/hapus\/161\/i24xf9w5hesinb8wv47g58w3g4fw83645erj",
"status": "OK",
"msg": "Berkas telah berhasil dihapus",
"ts_req": "2018-08-02 22:29:31.158955+07",
"ts_resp": "2018-08-02 22:29:31.205435+07",
"req_id": "27401"
}

Menghapus berkas

Field Keterangan
id_institusi ID Institusi Anda

Penitipan Berkas

Tempat penyimpanan berkas untuk jangka waktu tertentu

Booking URL

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"tipe_berkas": "PDF",
"catatan": "Invoice kepada Budi Haryono #INV1220/002/2019",
"expired": "2030-01-01"
}' \
https://bayar.id/api/smartbilling/berkas/booking-url-penitipan

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_berkas": 882,
"lokasi_berkas": "2018/08/02/email-institusi@institusi.com/14dd58f554660a50f8571f87d281e205ff9e5eb3.pdf",
"download_url": "https:\/\/bayar.id\/berkas\/deposit\/2018\/08\/02\/email-institusi@institusi.com\/14dd58f554660a50f8571f87d281e205ff9e5eb3.pdf",
"id_institusi":"2373278237823782378",
"tipe_berkas": "PDF",
"catatan": "Invoice kepada Budi Haryono #INV1220/002/2019",
"expired": "2030-01-01"
},
"function": "berkas/booking-url-penitipan",
"status": "OK",
"msg": "Sukses Booking URL Penitipan Berkas",
"ts_req": "2018-08-02 04:39:48.41592+07",
"ts_resp": "2018-08-02 04:39:48.474816+07",
"req_id": "27178"
}

Booking URL

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
tipe_berkas Ya tipe berkas (PDF, PNG, JPG, GIF, TXT, DOCX, XLSX, DOC, XLS)
expired Ya Waktu berkas auto-expide
Field Keterangan
id_institusi ID Institusi Anda
id ID berkas
lokasi_berkas Lokasi berkas di server
download_url URL untuk mendownload berkas
tipe_berkas Tipe berkas
expired Tanggal berkas akan dihapus secara otomatis

Unggah Berkas Titipan

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X PUT \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Filename: nama_berkas.xlsx' \
--upload-file {berkas_yang_ingin_diupload} \
https://bayar.id/api/smartbilling/berkas/unggah-titipan/{id_berkas}/{id_institusi}

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_berkas": "161",
"nama_berkas": "nama_berkas.xls",
"metadata_berkas": "application\/octet-stream; charset=binary",
"ukuran_berkas": "5878",
"lokasi_berkas": "2018/08/02/email-institusi@institusi.com/14dd58f554660a50f8571f87d281e205ff9e5eb3.pdf",
"download_url": "https:\/\/bayar.id\/berkas\/deposit\/2018\/08\/02\/email-institusi@institusi.com\/14dd58f554660a50f8571f87d281e205ff9e5eb3.pdf",
"id_institusi":"2373278237823782378",
"expired": "2030-01-01",
"sha1": "14dd58f554660a50f8571f87d281e205ff9e5eb3"
},
"function": "berkas/unggah-titipan",
"status": "OK",
"msg": "Upload berkas titipan Sukses",
"ts_req": "2018-08-02 04:39:48.41592+07",
"ts_resp": "2018-08-02 04:39:48.474816+07",
"req_id": "27178"
}

Mengunggah berkas

TBD

TBD

Unduh Berkas Titipan

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X GET \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
https://bayar.id/api/smartbilling/berkas/unduh-titipan/{id_berkas}/{id_institusi}

Script di atas akan mengembalikan HTTP Redirect menuju berkas yang dimaksud

{
"data": {
"download_url": "https:\/\/bayar.id\/berkas-titipan\/2018\/08\/02\/oirgbkjdkaskfjabksfbkjasfasfkhasf.xls?md5=bo43yalb7SWsX824FwRMiw&expires=1633223891",
"metadata_berkas": "application\/octet-stream; charset=binary",
"nama_berkas": "Coba.xls",
"ukuran_berkas": "9216"
},
"function": "berkas\/unduh-titipan",
"status": "OK",
"msg": "URL Download dapat digunakan sampai tanggal 2021-01-28 01:30:00",
"ts_req": "2018-08-02 22:29:31.158955+07",
"ts_resp": "2018-08-02 22:29:31.205435+07",
"req_id": "27401"
}

Mengunduh berkas

{id_berkas} contoh: 1241
{id_institusi} contoh: Soubae5uo1jahrue2sheequaifiechu8ohngeibu

Field Keterangan
id_institusi ID Institusi Anda

List Titipan Berkas

Silakan ganti XXXXX dengan token hasil Otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378"
}' \
https://bayar.id/api/smartbilling/berkas/list-unggah-titipan

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_berkas": 882,
"lokasi_berkas": "2018/08/02/email-institusi@institusi.com/14dd58f554660a50f8571f87d281e205ff9e5eb3.pdf",
"download_url": "https:\/\/bayar.id\/berkas\/deposit\/2018\/08\/02\/email-institusi@institusi.com\/14dd58f554660a50f8571f87d281e205ff9e5eb3.pdf",
"id_institusi":"2373278237823782378",
"metadata_berkas": "application\/octet-stream; charset=binary",
"catatan": "Invoice kepada Budi Haryono #INV1220/002/2019",
"expired": "2030-01-01"
},
{
"id_berkas": 883,
"lokasi_berkas": "2018/08/02/email-institusi@institusi.com/7d281e205ff9e5eb314dd58f554660a50f8571f8.pdf",
"download_url": "https:\/\/bayar.id\/berkas\/deposit\/2018\/08\/02\/email-institusi@institusi.com\/7d281e205ff9e5eb314dd58f554660a50f8571f8.pdf",
"id_institusi":"2373278237823782378",
"metadata_berkas": "application\/octet-stream; charset=binary",
"catatan": "Invoice kepada AHMAD MUZAKI #INV1221/002/2019",
"expired": "2030-01-01"
},
{
"id_berkas": 884,
"lokasi_berkas": "2018/08/02/email-institusi@institusi.com/660a50f8571f87d281e205ff9e5eb314dd58f554.pdf",
"download_url": "https:\/\/bayar.id\/berkas\/deposit\/2018\/08\/02\/email-institusi@institusi.com\/660a50f8571f87d281e205ff9e5eb314dd58f554.pdf",
"id_institusi":"2373278237823782378",
"metadata_berkas": "application\/octet-stream; charset=binary",
"catatan": "Invoice kepada CAHYANTO BUDI #INV1222/002/2019",
"expired": "2030-01-01"
}
],
"function": "berkas/list-unggah-titipan",
"status": "OK",
"msg": "List unggah titipan berkas, Berhasil",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2288"
}

List status proses Import Berkas Tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
batch_id Ya Nomor batch saat mengupload

Array of upload-status

Hapus Berkas Titipan

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X DELETE \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
https://bayar.id/api/smartbilling/berkas/hapus-titipan/{id_berkas}/{id_institusi}

Script di atas akan mengembalikan HTTP Redirect menuju berkas yang dimaksud

{
"data": {
"id_berkas": 882,
"lokasi_berkas": "2018/08/02/email-institusi@institusi.com/14dd58f554660a50f8571f87d281e205ff9e5eb3.pdf",
"download_url": "https:\/\/bayar.id\/berkas\/deposit\/2018\/08\/02\/email-institusi@institusi.com\/14dd58f554660a50f8571f87d281e205ff9e5eb3.pdf",
"id_institusi":"2373278237823782378",
"tipe_berkas": "PDF",
"catatan": "Invoice kepada Budi Haryono #INV1220/002/2019",
"expired": "2030-01-01"
},
"function": "berkas\/hapus-titipan",
"status": "OK",
"msg": "Berkas titpan telah berhasil dihapus",
"ts_req": "2018-08-02 22:29:31.158955+07",
"ts_resp": "2018-08-02 22:29:31.205435+07",
"req_id": "27401"
}

Menghapus berkas titipan

Field Keterangan
id_institusi ID Institusi Anda

Template & Generate PDF

Silakan ganti XXXXX dengan Token hasil login Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"payload": {
"data1": "Payload 1",
"data2": "Payload 2",
"data3": "Payload 3",
"data4": "Payload 4",
"data5": "Payload 5",
"data6": "Payload 6"
},
"template_pdf_form": "https://dev.bayar.id/berkas-share-titipan/1893430800/pbZef2jiRrbCqSxdZ-Cjrw/2019/11/03/guar199@gmail.com/7eee74c52ff4b6321616faa75bbf487fe00a57da.pdf"
}' \
https://bayar.id/api/smartbilling/berkas/insert-template-generate

Script di atas akan mengembalikan Binary File PDF

[TBD]

Personal

Tagihan Saya

List Tagihan Saya

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'GoogleOAuth: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"status_tagihan": "Menunggu Pemeriksaan",
"keyword": "coba BUDI",
"daftar_tagihan": [
{"id_institusi": "2373278237823782378", "nomor_pembayaran": "1806127277"},
{"id_institusi": "2373278237823782378", "nomor_pembayaran": "1706864664"},
{"id_institusi": "7836487578366272636", "nomor_pembayaran": "0032771662"}
],
"klasifikasi" : [
{"id_klasifikasi": "12", "id_pilihan_klasifikasi": "22"},
{"id_klasifikasi": "123", "id_pilihan_klasifikasi": "12123"}
],
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"status_tagihan","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"offset": "0",
"limit": "20"
}' \
https://bayar.id/api/smartbilling/personal/list-tagihan-saya

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_institusi":"2373278237823782378",
"nomor_invoice": "ABC12321AA37\/TAG\/2017",
"id_tagihan": "62213",
"revisi": "0",
"nomor_pembayaran": "0806444524",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"status_tagihan": "Menunggu Pemeriksaan",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01 00:00:00",
"sisa_waktu_tagihan": "10 hari",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"judul": "Info1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
}
],
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570",
"balance": "1500000",
"total_tagihan": "1500000",
"total_pembayaran": "0",
"status_tagihan": "Open",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
}
],
"summary": {
"summary_total_nominal_tagihan": 1500000,
"summary_total_tagihan": 1500000,
"summary_balance": -1500000,
"summary_total_pembayaran": 0
},
"function": "personal/list-tagihan-saya",
"status": "OK",
"msg": "Pencarian 'coba.com GUAR' Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

List Tagihan Saya

Field Wajib Diisi Keterangan
keyword Ya Kata Kunci yang akan anda cari
id_institusi Tidak Id Institusi yang menjadi filter
status_tagihan Tidak Status tagihan yang menjadi filter
daftar_tagihan Tidak Daftar Institusi & Nomor Pembayaran yang menjadi filter
klasifikasi Tidak Klasifikasi yang menjadi filter
order_by Tidak Urutan field
offset Tidak Offset data
limit Tidak Jumlah record yang diminta
Field Keterangan

[TBD]

Detail Tagihan Saya

Silakan ganti XXXXX dengan token hasil otentikasi Anda

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'GoogleOAuth: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_tagihan": "62213"
}' \
https://bayar.id/api/smartbilling/personal/detail-tagihan-saya

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_tagihan":"230",
"id_institusi":"2373278237823782378",
"nomor_invoice":"ABC12321AA37/TAG/2017",
"nomor_pembayaran":"0806444524",
"waktu_berlaku": "2018-01-01",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01",
"email":"coba@coba.com",
"nama": "AHMAD YANTO",
"nomor_hp": "081188990579",
"catatan": "Ini percobaan ubah",
"id_pelanggan":"0806444524",
"informasi": [
{
"label": "Info1",
"info": "Bayar Kuliah"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"label" : ["Lab Kimia", "Depok"],
"status_tagihan" : "Menunggu Persetujuan",
"revisi" : "2",
"daftar_revisi": [
{
"revisi" : "3",
"tanggal_revisi": "2018-06-20 01:10:04.205389+07",
"id_user": "12",
"nama_user": "Agus Budi"
},
{
"revisi" : "2",
"tanggal_revisi": "2018-06-19 01:10:04.205389+07",
"id_user": "172",
"nama_user": "Mohammad Fajri"
},
{
"revisi" : "1",
"tanggal_revisi": "2018-06-28 01:10:04.205389+07",
"id_user": "12",
"nama_user": "Agus Budi"
}
]
},
"function": "personal/detail-tagihan-saya",
"status": "OK",
"msg": "Pengambilan Detail Tagihan Sukses",
"ts_req": "2018-06-20 01:10:04.205389+07",
"ts_resp": "2018-06-20 01:10:05.560817+07",
"req_id": "1870"
}

Mendapatkan Detail Tagihan berdasarkan ID Tagihan

Field Wajib Diisi Keterangan
id_tagihan Ya ID tagihan di dalam sistem Smart Billing
id_institusi Tidak ID Institusi Anda
Field Keterangan

[TBD]

Buat Berkas Export

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'GoogleOAuth: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"status_tagihan": "Menunggu Pemeriksaan",
"keyword": "coba BUDI",
"klasifikasi" : [
{"id_klasifikasi": "12", "id_pilihan_klasifikasi": "22"},
{"id_klasifikasi": "123", "id_pilihan_klasifikasi": "12123"}
],
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"status_tagihan","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"deskripsi_export":"Percobaan export ke 1",
"tipe_berkas": "xls"
}' \
https://bayar.id/api/smartbilling/personal/export-tagihan-saya

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"status_tagihan": "Menunggu Pemeriksaan",
"keyword": "coba BUDI",
"klasifikasi" : [
{"id_klasifikasi": "12", "id_pilihan_klasifikasi": "22"},
{"id_klasifikasi": "123", "id_pilihan_klasifikasi": "12123"}
],
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"status_tagihan","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"deskripsi_export":"Percobaan export ke 1",
"tipe_berkas": "xlsx",
"id_berkas": "123456"
},
"function": "personal/export-tagihan-saya ",
"status": "OK",
"msg": "Sedang Menunggu Pemrosesan",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2287"
}

Export tagihan akan bisa diunduh pada fungsi Berkas->Unduh Berkas

[TBD]

[TBD]

Pembayaran Saya

List Pembayaran Saya

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'GoogleOAuth: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"status_pembayaran": "Menunggu Pemeriksaan",
"id_institusi": "278y3r82fweusdbjqowuigaicywegsbvjd",
"keyword": "coba BUDI",
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"status_pembayaran","direction":"ASC"}
],
"offset": "0",
"limit": "20"
}' \
https://bayar.id/api/smartbilling/personal/list-pembayaran-saya

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_record_pembayaran":"2373278237823782378",
"id_institusi":"2373278237823782378",
"institusi":"Fakultas Ekosistem",
"nomor_invoice": "ABC12321AA37\/TAG\/2017",
"revisi": "0",
"waktu_transaksi": "2018-11-21 11:23:42",
"nomor_panggil_pembayaran": "0806444524",
"kode_unik_transaksi_bank": "73166162312343534",
"waktu_transaksi_bank": "2018-11-21 11:22:55",
"kode_bank": "BSM",
"kanal_bayar_bank": "TELLER",
"kode_terminal_bank": "TERM00012",
"status_pembayaran": "Terbayar",
"billref": "Ohtheebee2zea1choox7egh5nohvoomee0Oogie2",
"metode_pembayaran": "Host2Host",
"catatan": "",
"id_operator": "bsm002",
"kode_unik_transaksi_switching": "payment-PaiwohvooPheeSu6ohy0eeg4ap2zieVe6eileghu",
"kode_jurnal_bank": "ABBL727615533/FT0072765155321243",
"kode_unik_reversal_bank": "",
"kode_unik_reversal_switching": "",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01 00:00:00",
"total_nominal_pembayaran": "1500000",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"judul": "Info1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
}
],
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570",
"balance": "0",
"total_tagihan": "1500000",
"total_pembayaran": "1500000",
"status_tagihan": "Closed",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
}
],
"function": "personal/list-pembayaran-saya",
"summary": {
"summary_total_nominal_tagihan" : 1500000,
"summary_total_tagihan": 1500000,
"summary_balance": 0,
"summary_total_pembayaran": 1500000
},
"status": "OK",
"msg": "Pencarian Pembayaran 'coba.com GUAR' Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

List Transaksi Saya

Field Wajib Diisi Keterangan
keyword Ya Kata Kunci yang akan anda cari
Field Keterangan

[TBD]

Detil Pembayaran Saya

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'GoogleOAuth: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_record_pembayaran": "74746464"
}' \
https://bayar.id/api/smartbilling/personal/detil-pembayaran-saya

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_record_pembayaran":"74746464",
"id_institusi":"2373278237823782378",
"nomor_invoice": "ABC12321AA37\/TAG\/2017",
"revisi": "0",
"waktu_transaksi": "2018-11-21 11:23:42",
"nomor_panggil_pembayaran": "0806444524",
"kode_unik_transaksi_bank": "73166162312343534",
"waktu_transaksi_bank": "2018-11-21 11:22:55",
"kode_bank": "BSM",
"kanal_bayar_bank": "TELLER",
"kode_terminal_bank": "TERM00012",
"total_nominal_pembayaran": "1500000",
"status_pembayaran": "Terbayar",
"billref": "Ohtheebee2zea1choox7egh5nohvoomee0Oogie2",
"metode_pembayaran": "Host2Host",
"catatan": "",
"id_operator": "bsm002",
"kode_unik_transaksi_switching": "payment-PaiwohvooPheeSu6ohy0eeg4ap2zieVe6eileghu",
"kode_jurnal_bank": "ABBL727615533/FT0072765155321243",
"kode_unik_reversal_bank": "",
"kode_unik_reversal_switching": "",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01 00:00:00",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"judul": "Info1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
}
],
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570",
"balance": "0",
"total_tagihan": "1500000",
"total_pembayaran": "1500000",
"status_tagihan": "Closed",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
}
],
"function": "personal/detil-pembayaran-saya",
"status": "OK",
"msg": "Pencarian Detil Pembayaran Saya Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Detil Transaksi Saya

Field Wajib Diisi Keterangan
keyword Ya Kata Kunci yang akan anda cari
Field Keterangan

[TBD]

List Institusi Penagih

Silakan ganti XXXXX dengan Token hasil otentikasi Anda

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'GoogleOAuth: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{}' \
https://bayar.id/api/smartbilling/personal/list-institusi-penagih

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data":
[
{
"id_institusi": "b2f670bee79e897297f1aa85184bbd6d",
"nama_institusi": "Fakultas Eko",
"deskripsi_institusi": "Fakultas yang mempelajari Eko",
"status_institusi": "Aktif"
},
{
"id_institusi": "ce3bda5f0593e25504c73df1b1806d15",
"nama_institusi": "STAIMI",
"deskripsi_institusi": "SEKOLAH TINGGI AGAMA ISLAM",
"status_institusi": "Aktif"
}
],
"function": "personal/list-institusi-penagih",
"status": "OK",
"msg": "List Institusi Penagih Sukses",
"ts_req": "2018-07-29 06:49:58.470322+07",
"ts_resp": "2018-07-29 06:49:58.522591+07",
"req_id": "9144"
}

Menampilkan daftar Institusi penagih

Field Keterangan
data Hasil seluruh data dari kata kunci yang kita cari

Hak Akses Saya

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'GoogleOAuth: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
https://bayar.id/api/smartbilling/personal/hak-akses-saya

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_institusi": "23787234",
"nama_institusi": "Asrama Mahasiswa",
"peran_organisasi": "Biller",
"hak_akses_saya": [
"Melihat Tagihan",
"Membuat Tagihan"
]
},
{
"id_institusi": "27381811",
"nama_institusi": "Fakultas Ilmu Gurun Pasir",
"peran_organisasi": "Biller",
"hak_akses_saya": [
"Membuat Tagihan"
]
},
{
"id_institusi": "3868118222",
"nama_institusi": "Fitnes Center",
"peran_organisasi": "Biller",
"hak_akses_saya": [
"Melihat Tagihan"
]
},
],
"function": "personal/hak-akses-saya",
"status": "OK",
"msg": "Melihat hak akses saya, berhasil",
"ts_req": "2018-07-21 03:04:13.514184+07",
"ts_resp": "2018-07-21 03:04:13.592046+07",
"req_id": "5165"
}

Mengambil Hak aktifitas sebuah user terhadap institusi-institusi di dalam API BPI.

Tidak ada payload HTML POST.

Field Keterangan
id_institusi ID Institusi
nama_institusi Nama Institusi
peran_institusi Peran Institusi
hak_akses_saya Aktifitas-aktifitas yang dapat dilakukan di dalam Institusi

Profil Saya

Silakan ganti XXXXXXXXXXXXXXXXXXXXXXXXXXXXX dengan Token yang Anda dapatkan saat Login.

curl \
-X POST \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'GoogleOAuth: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
https://bayar.id/api/smartbilling/personal/profil-saya

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"email": "emailsaya@mail.com",
"nama_depan": "Nama Depan Saya",
"nama_belakang": "Nama Belakang Saya",
"waktu_daftar": "2019-04-01 22:05:30",
"waktu_terakhir_login": "2019-05-02 09:25:05"
},
"function": "personal/profil-saya",
"status": "OK",
"msg": "Melihat Profil Saya, berhasil.",
"ts_req": "2018-07-21 03:04:13.514184+07",
"ts_resp": "2018-07-21 03:04:13.592046+07",
"req_id": "5165"
}

Mengambil informasi Profil Saya dari dalam API BPI.

Tidak ada payload HTML POST.

Field Keterangan
email Email
nama_depan Nama Depan
nama_belakang Nama Belakang
waktu_daftar Waktu daftar ke Smart Billing
waktu_terakhir_login Waktu terakhir login ke Smart Billing

Pelanggan

Laporan Status Pelunasan

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"keyword": "guar",
"prefix": ["01","02"],
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"email","direction":"ASC"},
{"field":"nomor_hp","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"offset": "0",
"limit": "20"
}' \
https://bayar.id/api/smartbilling/laporan/status-pelunasan

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_institusi":"2373278237823782378",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570"
}
],
"function": "laporan/status-pelunasan",
"status": "OK",
"msg": "Laporan Status Pelunasan Pelanggan 'guar' Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Daftar Status Pelunasan Pelanggan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
keyword Ya Kata Kunci yang akan anda cari
prefix Tidak Array prefix dari nomor pembayaran
Field Keterangan

[TBD]

Buat Berkas Export Pelanggan

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"deskripsi_export":"Percobaan export ke 1",
"tipe_berkas": "xls",
"keyword": "",
"prefix": ["01","02"],
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"nama","direction":"DESC"}
]
}' \
https://bayar.id/api/smartbilling/pelanggan/export-berkas

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_proses": "231222",
"id_berkas": "183",
"id_institusi":"2373278237823782378",
"deskripsi_export":"Percobaan export ke 1",
"status_proses" : "Menunggu Pemrosesan"
},
"function": "pelanggan/export-berkas",
"status": "OK",
"msg": "Sedang Menunggu Pemrosesan",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2287"
}

Export pelanggan akan bisa diunduh pada fungsi Berkas->Unduh Berkas

[TBD]

[TBD]

Laporan Jurnal

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"keyword": "guar",
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"email","direction":"ASC"},
{"field":"nomor_hp","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"offset": "0",
"limit": "20"
}' \
https://bayar.id/api/smartbilling/laporan/jurnal

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_institusi":"2373278237823782378",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570"
}
],
"function": "laporan/jurnal",
"status": "OK",
"msg": "Laporan Jurnal Pelanggan 'guar' Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Daftar Status Pelunasan Pelanggan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
keyword Ya Kata Kunci yang akan anda cari
Field Keterangan

[TBD]

Buat Berkas Export Pelanggan

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"deskripsi_export":"Percobaan export ke 1",
"tipe_berkas": "xls",
"keyword": "",
"order_by": [
{"field":"id_institusi","direction":"ASC"},
{"field":"nama","direction":"DESC"}
]
}' \
https://bayar.id/api/smartbilling/pelanggan/export-berkas

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_proses": "231222",
"id_berkas": "183",
"id_institusi":"2373278237823782378",
"deskripsi_export":"Percobaan export ke 1",
"status_proses" : "Menunggu Pemrosesan"
},
"function": "pelanggan/export-berkas",
"status": "OK",
"msg": "Sedang Menunggu Pemrosesan",
"ts_req": "2018-06-20 21:03:34.382817+07",
"ts_resp": "2018-06-20 21:03:35.10084+07",
"req_id": "2287"
}

Export pelanggan akan bisa diunduh pada fungsi Berkas->Unduh Berkas

[TBD]

[TBD]

Virtual Account

Cari Tagihan

Silakan ganti XXXXX dengan username/email, dan YYYYY dengan password Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"status_tagihan": "Menunggu Pemeriksaan",
"keyword": "coba BUDI",
"klasifikasi" : [
{"id_klasifikasi": "12", "id_pilihan_klasifikasi": "22"},
{"id_klasifikasi": "123", "id_pilihan_klasifikasi": "12123"}
],
"order_by": [
{"field":"status_tagihan","direction":"ASC"},
{"field":"nama","direction":"DESC"}
],
"offset": "0",
"limit": "20"
}' \
https://bayar.id/api/smartbilling/tagihan/cari

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_institusi":"2373278237823782378",
"id_tagihan": "ABC12321AA37\/TAG\/2017",
"revisi": "0",
"nomor_pembayaran": "0806444524",
"id_pelanggan": "88967345",
"nama": "NEAL GUARDDIN",
"status_tagihan": "Menunggu Pemeriksaan",
"waktu_berlaku": "1970-01-01 00:00:00",
"waktu_jatuh_tempo": "2020-01-01",
"waktu_kedaluwarsa": "2020-01-01 00:00:00",
"total_nominal_tagihan": "1500000",
"informasi": [
{
"judul": "Info1",
"isi": "Bayar Kuliah",
"tipe": "inq_pay"
}
],
"email": "coba@coba.com",
"catatan": "",
"nomor_hp": "08118880570",
"balance": "1500000",
"total_tagihan": "1500000",
"total_pembayaran": "0",
"status_tagihan": "Open",
"rincian": [
{
"kode": "001",
"deskripsi": "Tagihan Semesteran",
"nominal": "1200000"
},
{
"kode": "002",
"deskripsi": "Denda",
"nominal": "300000"
}
],
"klasifikasi": [
{
"id_klasifikasi": "170",
"nama_klasifikasi": "Fakultas",
"id_pilihan_klasifikasi": "1",
"nama_pilihan_klasifikasi": "Fakultas Ilmu Komputer"
},
{
"id_klasifikasi": "171",
"nama_klasifikasi": "Angkatan",
"id_pilihan_klasifikasi": "2",
"nama_pilihan_klasifikasi": "2016"
}
],
}
],
"function": "tagihan/cari",
"status": "OK",
"msg": "Pencarian 'coba.com GUAR' Sukses",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Mencari Tagihan

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
keyword Ya Kata Kunci yang akan anda cari
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda
nomor_pembayaran Nomor yang bisa dipergunakan untuk melakukan pembayaran di kanal pembayaran (ATM, Inet Banking, Mobile Banking, dll)
id_pelanggan Nomor pelanggan di lingkungan internal Institusi Anda
nama Informasi nama yang ingin ditagih
informasi Minimal diisi 1 set {‘label’ & ‘info’}. Informasi ini akan ditampilkan & dicetak pada bukti pembayaran
status_tagihan berisi status tagihan tsb. apakah “open” untuk jumlah pembayaran boleh tidak sama dengan total tagihan, dan “closed” untuk jumlah pembayaran harus sama dengan total tagihan
rincian Minimal diisi 1 set {‘kode’, ‘deskripsi’, & ‘nominal’}. Rincian ini merupakan data dasar penagihan. Akumulasi dari nominal di dalam rincian adalah menjadi total nilai tagihan yang harus dibayar.
nomor_invoice Nomor Invoice dari Institusi Anda
status_approval Status Tagihan sudah approved atau belum
waktu_berlaku Waktu dimulainya tagihan ini.
waktu_jatuh_tempo Waktu jatuh tempo.
waktu_kedaluwarsa Waktu kedaluwarsa.
total_nominal_tagihan Total nominal tagihan.
email Alamat surat elektronik dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
nomor_hp Nomor HP dari pembayar. Informasi ini dipergunakan untuk pengiriman notifikasi & bukti pembayaran.
klasifikasi Informasi yang dapat dipergunakan untuk pengelolaan data & laporan atas tagihan & pembayaran di dalam Institusi Anda.
catatan Informasi tambahan yang dapat dipergunakan untuk keperluan administrasi

Buat Virtual Account

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

Custom Value

Create

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"key1": "custom_key_1",
"key2": "custom_key_2",
"key3": "custom_key_3",
"val1": "Custom Value 1",
"val2": "Custom Value 2",
"val3": "Custom Value 3",
"val4": "Custom Value 4",
"val5": "Custom Value 5"
}' \
https://bayar.id/api/smartbilling/custom/create

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"key1": "custom_key_1",
"key2": "custom_key_2",
"key3": "custom_key_3",
"val1": "Custom Value 1",
"val2": "Custom Value 2",
"val3": "Custom Value 3",
"val4": "Custom Value 4",
"val5": "Custom Value 5"
},
"function": "custom/create",
"status": "OK",
"msg": "Pembuatan Custom Value 'custom_key_1', 'custom_key_2', 'custom_key_3' berhasil",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Create Custom Value

Field Wajib Diisi Keterangan

[TBD]

Field Keterangan

[TBD]

Read

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"key1": "custom_key_1",
"key2": "custom_key_2",
"key3": "custom_key_3",
"val1": "Custom Value 1",
"val2": "Custom Value 2",
"val3": "Custom Value 3",
"val4": "Custom Value 4",
"val5": "Custom Value 5"
}' \
https://bayar.id/api/smartbilling/custom/read

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"seq": "27",
"id_institusi":"2373278237823782378",
"key1": "custom_key_1",
"key2": "custom_key_2",
"key3": "custom_key_3",
"val1": "Custom Value 1",
"val2": "Custom Value 2",
"val3": "Custom Value 3",
"val4": "Custom Value 4",
"val5": "Custom Value 5",
"id_operator": "guar199@gmail.com",
"ts_update": "2019-08-19 12:05:58.072524"
},
"function": "custom/read",
"status": "OK",
"msg": "Pengambilan Custom Value 'custom_key_1', 'custom_key_2', 'custom_key_3' berhasil",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Read Custom Value

Field Wajib Diisi Keterangan

[TBD]

Field Keterangan

[TBD]

Update

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"key1": "custom_key_1",
"key2": "custom_key_2",
"key3": "custom_key_3",
"val1": "Updated Custom Value 1",
"val2": "Updated Custom Value 2",
"val3": "Updated Custom Value 3",
"val4": "Updated Custom Value 4",
"val5": "Updated Custom Value 5"
}' \
https://bayar.id/api/smartbilling/custom/update

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"key1": "custom_key_1",
"key2": "custom_key_2",
"key3": "custom_key_3",
"val1": "Updated Custom Value 1",
"val2": "Updated Custom Value 2",
"val3": "Updated Custom Value 3",
"val4": "Updated Custom Value 4",
"val5": "Updated Custom Value 5"
},
"function": "custom/update",
"status": "OK",
"msg": "Update Custom Value 'custom_key_1', 'custom_key_2', 'custom_key_3' berhasil",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Update Custom Value

Field Wajib Diisi Keterangan

[TBD]

Field Keterangan

[TBD]

Delete

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"key1": "custom_key_1",
"key2": "custom_key_2",
"key3": "custom_key_3"
}' \
https://bayar.id/api/smartbilling/custom/delete

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi":"2373278237823782378",
"key1": "custom_key_1",
"key2": "custom_key_2",
"key3": "custom_key_3"
},
"function": "custom/delete",
"status": "OK",
"msg": "Delete Custom Value 'custom_key_1', 'custom_key_2', 'custom_key_3' berhasil",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Delete Custom Value

Field Wajib Diisi Keterangan

[TBD]

Field Keterangan

[TBD]

Next Value

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"key1": "nomor_invoice",
"key2": "2019-01-02",
"key3": "",
"fields": [
"val1",
"val2"
]
}' \
https://bayar.id/api/smartbilling/custom/nextval

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"seq": "27",
"id_institusi":"2373278237823782378",
"key1": "nomor_invoice",
"key2": "2019-01-02",
"key3": "",
"val1": "109",
"val2": "80277",
"val3": "",
"val4": "",
"val5": "",
"id_operator": "guar199@gmail.com",
"ts_update": "2019-08-19 12:05:58.072524"
},
"function": "custom/update",
"status": "OK",
"msg": "Next Val 'nomor_invoice', '2019-01-02', '' berhasil",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Next Custom Value

Field Wajib Diisi Keterangan

[TBD]

Field Keterangan

[TBD]

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"key1": "anggota",
"keyword": "budi"
}' \
https://bayar.id/api/smartbilling/custom/read

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"seq": "27",
"id_institusi":"2373278237823782378",
"key1": "anggota",
"key2": "",
"key3": "",
"val1": "Budianto",
"val2": "budianto@gmail.com",
"val3": "",
"val4": "",
"val5": "",
"id_operator": "guar199@gmail.com",
"ts_update": "2019-08-19 12:05:58.072524"
},
{
"seq": "28",
"id_institusi":"2373278237823782378",
"key1": "anggota",
"key2": "",
"key3": "",
"val1": "Budi Santoso",
"val2": "budi@santoso.com",
"val3": "",
"val4": "",
"val5": "",
"id_operator": "guar199@gmail.com",
"ts_update": "2019-08-19 12:05:58.072524"
}
],
"function": "custom/read",
"status": "OK",
"msg": "Pengambilan Custom Value 'custom_key_1', 'custom_key_2', 'custom_key_3' berhasil",
"ts_req": "2018-06-20 08:31:56.121366+07",
"ts_resp": "2018-06-20 08:31:57.383378+07",
"req_id": "2034"
}

Read Custom Value

Field Wajib Diisi Keterangan

[TBD]

Field Keterangan

[TBD]

Pengumuman

Buat Broadcast

Silakan ganti XXXXX dengan token hasil otentikasi Anda.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "3537f4ade89e57b9dc1670271f3d3003",
"judul_template": "From Postman 6",
"isi_template": "isi template lagi",
"nama_batch": "POSTMAN",
"waktu_broadcast": "2021-09-09 19:19:19",
"tujuan_penerima": [
{"nama":"darell", "nomor_hp":"6289563545367", "email":"lalala@gmail.com"},
{"nama":"budi", "nomor_hp":"6289563545369", "email":"budi@gmail.com"}
],
"channel": "email"
}' \
https://bayar.id/api/smartbilling/pengumuman/tambah-broadcast
<?php
$url = "https://bayar.id/api/smartbilling/pengumuman/tambah-broadcast";

$token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$arr_headers = array(
'API-Environment: trial',
'Authorization: Bearer ' . $token
);
$arr_payload = array (
"id_institusi" => "3537f4ade89e57b9dc1670271f3d3003",
"judul_template" => "From Postman 6",
"isi_template" => "isi template lagi",
"nama_batch" => "POSTMAN",
"waktu_broadcast" => "2021-09-09 19:19:19",
'tujuan_penerima' => array (
0 => array (
'nama' => 'darell',
'nomor_hp' => '6289563545367',
'email' => 'lalala@gmail.com',
),
1 => array (
'judul' => 'budi',
'isi' => '6289563545369',
'tipe' => 'budi@gmail.com',
),
),
'channel' => 'email',
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url;
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $arr_headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arr_payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
echo $result;
?>

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "3537f4ade89e57b9dc1670271f3d3003",
"judul_template": "From Postman 6",
"isi_template": "isi template lagi",
"nama_batch": "POSTMAN",
"waktu_broadcast": "2021-09-09 19:19:19",
"tujuan_penerima": [
{
"nama": "darell",
"nomor_hp": "89524684246",
"email": "lhendry@gmail.com"
},
{
"nama": "budi",
"nomor_hp": "89524684242",
"email": "budi@gmail.com"
}
],
"channel": "email"
},
"function": "pengumuman/tambah-broadcast",
"status": "OK",
"msg": "Tambah broadcast sukses dengan jumlah tujuan penerima sebanyak 2",
"ts_req": "2021-02-01 16:40:35.541565+07",
"ts_resp": "2021-02-01 16:40:35.607221+07",
"req_id": "288403"
}
curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi": "3537f4ade89e57b9dc1670271f3d3003",
"judul_template": "From Postman 6",
"isi_template": "isi template lagi",
"nama_batch": "POSTMAN",
"waktu_broadcast": "2021-09-09 19:19:19",
"tujuan_penerima": [
{"nama":"darell", "nomor_hp":"6289563545367", "email":"lalala@gmail.com"},
{"nama":"budi", "nomor_hp":"6289563545369", "email":"budi@gmail.com"}
],
"channel": "email"
}' \
https://bayar.id/api/smartbilling/pengumuman/tambah-broadcast

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "3537f4ade89e57b9dc1670271f3d3003",
"judul_template": "From Postman 6",
"isi_template": "isi template lagi",
"nama_batch": "POSTMAN",
"waktu_broadcast": "2021-09-09 19:19:19",
"tujuan_penerima": [
{
"nama": "darell",
"nomor_hp": "89524684246",
"email": "lhendry@gmail.com"
},
{
"nama": "budi",
"nomor_hp": "89524684242",
"email": "budi@gmail.com"
}
],
"channel": "email",
"0": {
"status": "Terjadi kesalahan saat pengiriman"
}
},
"function": "pengumuman/tambah-broadcast",
"status": "OK",
"msg": "Tambah broadcast sukses dengan jumlah tujuan penerima sebanyak 2",
"ts_req": "2021-02-01 16:40:35.541565+07",
"ts_resp": "2021-02-01 16:40:35.607221+07",
"req_id": "288403"
}

Membuat tagihan untuk customer institusi tertentu.

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
judul_template Ya Judul yang pengumuman Anda
isi_template Ya Isi pengumuman Anda
nama_batch Ya Nama batch pengiriman broadacast Anda
waktu_broadcast Ya Waktu mulai sistem akan mengirimkan broadcast kepada tujuan
tujuan_penerima Ya Minimal diisi satu set {‘nama’, ‘email’, ‘nomor_hp’}
channel Ya channel pengiriman ada 3 opsi (email, whatsapp, email & whatsapp).
Field Keterangan
id_tagihan ID tagihan di dalam sistem Smart Billing
id_institusi ID Institusi Anda
judul_template Judul yang pengumuman Anda
isi_template Isi pengumuman Anda dapat berupa HTML, jika pengiriman ke whatsapp html akan diconvert ke teks
nama_batch Nama batch pengiriman broadacast Anda
waktu_broadcast Waktu mulai sistem akan mengirimkan broadcast kepada tujuan
tujuan_penerima Minimal diisi satu set {‘nama’, ‘email’, ‘nomor_hp’}
channel channel pengiriman ada 3 opsi (email, whatsapp, email & whatsapp).

Ubah Broadcast

Silakan ganti XXXXX dengan token hasil otentikasi Anda

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_batch": 10,
"id_institusi": "3537f4ade89e57b9dc1670271f3d3003",
"judul_template": "Pengumuman UPDATE",
"isi_template": "isi template UPDATE",
"nama_batch": "Batch Batch Batch batch",
"waktu_broadcast": "2021-02-09 20:00:00",
"tujuan_penerima": [
{"nama":"darell", "nomor_hp":"6289563545367", "email":"lhendry@gmail.com"},
{"nama":"budi", "nomor_hp":"6289563545369", "email":"budi@gmail.com"}
]
}' \
https://bayar.id/api/smartbilling/pengumuman/ubah-broadcast
<?php
$url = "https://bayar.id/api/smartbilling/pengumuman/ubah-broadcast";

$token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$arr_headers = array(
'API-Environment: trial',
'Authorization: Bearer ' . $token
);
$arr_payload = array (
"id_batch" => 10,
"id_institusi" => "3537f4ade89e57b9dc1670271f3d3003",
"judul_template" => "Pengumuman UPDATE",
"isi_template" => "isi template UPDATE",
"nama_batch" => "Batch Batch Batch batch",
"waktu_broadcast" => "2021-02-09 20:00:00",
'tujuan_penerima' => array (
0 => array (
'nama' => 'darell',
'nomor_hp' => '6289563545367',
'email' => 'lalala@gmail.com',
),
1 => array (
'judul' => 'budi',
'isi' => '6289563545369',
'tipe' => 'budi@gmail.com',
),
)
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url;
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $arr_headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arr_payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
echo $result;
?>

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"id_institusi": "3537f4ade89e57b9dc1670271f3d3003",
"judul_template": "Pengumuman UPDATE",
"isi_template": "isi template UPDATE",
"nama_batch": "Batch Batch Batch batch",
"waktu_broadcast": "2021-02-09 20:00:00",
"tujuan_penerima": [
{
"nama": "darell",
"nomor_hp": "89524684246",
"email": "lhendry@gmail.com"
},
{
"nama": "budi",
"nomor_hp": "89524684242",
"email": "budi@gmail.com"
}
],
"id_batch": 10
},
"function": "pengumuman/ubah-broadcast",
"status": "OK",
"msg": "Update Data Batch Sukses",
"ts_req": "2021-02-01 17:16:46.368393+07",
"ts_resp": "2021-02-01 17:16:46.439848+07",
"req_id": "288409"
}

Mengubah Tagihan yang belum dibayar

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
id_batch Ya ID Batch Anda
judul_template Ya Judul yang pengumuman Anda
isi_template Ya Isi pengumuman Anda
nama_batch Ya Nama batch pengiriman broadacast Anda
waktu_broadcast Ya Waktu mulai sistem akan mengirimkan broadcast kepada tujuan
tujuan_penerima Ya Minimal diisi satu set {‘nama’, ‘email’, ‘nomor_hp’}
Field Keterangan
id_institusi ID Institusi Anda
id_batch ID Batch Anda
judul_template Judul yang pengumuman Anda
isi_template Isi pengumuman Anda
nama_batch Nama batch pengiriman broadacast Anda
waktu_broadcast Waktu mulai sistem akan mengirimkan broadcast kepada tujuan
tujuan_penerima Minimal diisi satu set {‘nama’, ‘email’, ‘nomor_hp’}

Riwayat Broadcast

Silakan ganti XXXXX dengan token hasil otentikasi.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378"
}' \
https://bayar.id/api/smartbilling/pengumuman/riwayat-broadcast

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": [
{
"id_batch": "44",
"nama_batch": "Batch Batch Batch batch",
"waktu_broadcast": "2021-02-09 19:00:00",
"status": "1",
"channel": "whatsapp",
"jumlah_email_terkirim": "0",
"jumlah_whatsapp_terkirim": "0",
"tujuan_penerima": "[{\"nama\":\"darell\",\"nomor_hp\":\"89524684246\",\"email\":\"lhendry@gmail.com\"},{\"nama\":\"budi\",\"nomor_hp\":\"89524684242\",\"email\":\"budi@gmail.com\"}]"
},
{
"id_batch": "110",
"nama_batch": "test masuk wa",
"waktu_broadcast": "2021-01-26 02:51:19",
"status": "1",
"channel": "whatsapp",
"jumlah_email_terkirim": "0",
"jumlah_whatsapp_terkirim": "0",
"tujuan_penerima": "[{\"id\":1,\"nama\":\"Isabella Holman\",\"nomor_hp\":6289523874999,\"email\":\"iIsabellaholman@gmail.com\"},{\"id\":2,\"nama\":\"Suzanna Lutz\",\"nomor_hp\":6289523874991,\"email\":\"suzannalutz@gmail.com\"},{\"id\":3,\"nama\":\"Darell Hendry\",\"nomor_hp\":6285158457770,\"email\":\"darell@bayar.co.id\"},{\"id\":4,\"nama\":\"Ali\",\"nomor_hp\":6285158457770,\"email\":\"1darellhendry@gmail.com\"}]"
}

],
"function": "pengumuman/riwayat-broadcast",
"status": "OK",
"msg": "Ambil Riwayat Broadcast Sukses",
"ts_req": "2021-02-01 17:23:50.05664+07",
"ts_resp": "2021-02-01 17:23:50.127438+07",
"req_id": "288411"
}

Membatalkan Tagihan yang belum dibayar

Field Wajib Diisi Keterangan
id_institusi Ya ID Institusi Anda
Field Keterangan
id_institusi ID Institusi Anda

Detail Broadcast

Silakan ganti XXXXX dengan token hasil otentikasi.

curl \
-X POST \
--header 'API-Environment: trial' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"id_institusi":"2373278237823782378",
"id_batch": 6
}' \
https://bayar.id/api/smartbilling/pengumuman/detail

Script di atas akan mengembalikan JSON dengan struktur sebagai berikut:

{
"data": {
"seq": "6",
"judul_template": "Pengumuman",
"isi_template": "test test",
"nama_batch": "Batch Pengumuman",
"waktu_broadcast": "2021-02-02 19:00:00",
"tujuan_penerima": "[{\"nama\":\"darell\",\"nomor_hp\":\"6289564353453\",\"email\":\"lhendry@gmail.com\"},{\"nama\":\"budi\",\"nomor_hp\":\"6289564353453\",\"email\":\"budi@gmail.com\"}]",
"id_institusi": "2373278237823782378",
"status": "1",
"channel": "email",
"jumlah_email_terkirim": "0",
"jumlah_whatsapp_terkirim": "0",
"sudah_terkirim": "0"
},
"function": "pengumuman/detail",
"status": "OK",
"msg": "Ambil Detail Template Sukses",
"ts_req": "2021-02-01 17:26:44.357495+07",
"ts_resp": "2021-02-01 17:26:44.424944+07",
"req_id": "288413"
}

Menghapus Tagihan yang belum dibayar

Field Wajib Diisi Keterangan
id_batch Ya ID batch di dalam sistem Smart Billing
id_institusi Ya ID Institusi Anda
Field Keterangan
id_batch ID batch di dalam sistem Smart Billing
id_institusi ID Institusi Anda

Status Request API

API Bayar.ID akan mengembalikan salah satu kode status atas setiap pemanggilan API, sebagai berikut:

Status Arti Contoh message
OK Sukses Otentikasi berhasil, Logout berhasil, dll
ERR-AUTH Kesalahan saat melakukan Otentikasi API Key expired, API Key blacklisted, Username/Password salah
ERR-DB Kesalahan pada pengolahan di dalam database Server Bayar.ID Database error
ERR-ARG Kesalahan validasi argumen request API Argumen tidak lengkap