BRIZZI
Informasi API
Title | BRIZZI |
---|---|
Version |
v1.0 |
URL Sandbox |
https://sandbox.partner.api.bri.co.id/v1/brizzi/topup |
URL Production |
https://partner.api.bri.co.id/v1/brizzi/topup |
Kendali Versi
Versi Dok |
Versi API |
Tanggal |
Tautan Dokumen |
Deskripsi |
---|---|---|---|---|
v1.0 |
v1.0 |
1 February 2019 |
Halaman Ini |
Versi Awal |
Deskripsi Produk
API BRIZZI membuat Anda dapat mengisi ulang kartu BRIZZI. BRIZZI terdiri dari API dan SDK. Endpoint BRIZZI API digunakan untuk fungsi isi ulang. SDK BRIZZI digunakan untuk membaca dan menulis data pada kartu BRIZZI contohnya untuk pemeriksaan saldo kartu, riwayat transaksi kartu, dan pengecekan saldo kartu. SDK BRI hanya bekerja pada perangkat berbasis Android.
Flow API
A. Validate Card Number
Penjelasan Endpoint
Endpoint ini digunakan untuk memvalidasi apakah nasabah menggunakan nomor kartu BRIZZI yang valid atau tidak saat melakukan isi ulang.
curl --location --request POST 'https://sandbox.partner.api.bri.co.id/v1/brizzi/topup/checknum' \ --header 'Content-Type: application/json' \ --header 'BRI-Signature: {{SIGNATURE}} \ --header 'BRI-Timestamp: {{TIMESTAMP}}' \ --header 'Authorization: Bearer {{TOKEN}}' \ --data-raw '{ "username": "John Doe", "card_number": "5221123456789101" }'
Contoh Response:
{ "status" { "code" "00", "desc" "SUCCESS" } }
HTTP Request
POST https://sandbox.partner.api.bri.co.id/v1/brizzi/topup/checknum
Request Body
Field | Data Type | Max Char | Mandatory | Deskripsi |
---|---|---|---|---|
username | String | - | Yes | Nama pengguna yang digunakan pada aplikasi pihak ketiga |
card_number | Numeric | 16 | Yes | Nomor kartu Brizzi yang akan diisi ulang |
Response Body
Field | Data Type | Max Char | Mandatory | Deskripsi |
---|---|---|---|---|
status | ||||
code | String | 2 | Yes | Response status code |
desc | String | - | Yes | Response status description |
B. Top Up
Penjelasan Endpoint
Endpoint ini digunakan untuk mengisi ulang kartu BRIZZI. Saldo BRIZZI akan tersimpan dan diperbarui pada backend BRIZZI. Update saldo pada kartu dapat dilakukan menggunakan metode Update Pending Balance melalui SDK.
curl --location --request POST 'https://sandbox.partner.api.bri.co.id/v1/brizzi/topup' \ --header 'BRI-Signature: {{SIGNATURE}}' \ --header 'BRI-Timestamp: {{TIMESTAMP}}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{TOKEN}}' \ --data-raw '{ "username":"John Doe", "card_number":"5221123456789101", "amount":"1000", "reff_number":"123762" }'
Contoh Response
{ "status": { "code": "00", "desc": "SUCCESS" }, "brizzi": { "amount": "100000", "pending_balance": "150000", "reff_number": "100001" } }
HTTP Request
POST https://sandbox.partner.api.bri.co.id/v1/brizzi/topup
Request Body
Field | Data Type | Max Char | Mandatory | Deskripsi |
---|---|---|---|---|
username | String | - | Yes | Nama pengguna yang digunakan pada aplikasi pihak ketiga (digunakan untuk rekonsiliasi) |
card_number | Numeric | 16 | Yes | Nomor kartu Brizzi yang akan diisi ulang |
amount | Numeric | 7 | Yes | Nominal top up |
reff_number | String | 30 | Yes | Nomor referensi yang digunakan untuk rekonsiliasi |
Response Body
Field | Data Type | Max Char | Mandatory | Deskripsi |
---|---|---|---|---|
status | ||||
code | String | 2 | Yes | Response status code |
desc | String | - | Yes | Response status description |
brizzi | ||||
amount | Numeric | 7 | Yes | Nominal top up |
pending_balance | Numeric | 7 | Yes | Saldo tertunda yang tersimpan |
reff_number | String | 30 | Yes | Nomor referensi yang digunakan untuk rekonsiliasi |
C. Check Top Up Status
Penjelasan Endpoint
Endpoint ini digunakan untuk memeriksa status isi ulang yang telah dilakukan. Biasanya endpoint ini digunakan ketika Anda melakukan permintaan isi ulang, namun Anda tidak mendapatkan respon apapun dari BRIAPI.
curl --location --request POST 'https://sandbox.partner.api.bri.co.id/v1/brizzi/topup/checktrx' \ --header 'Content-Type: application/json' \ --header 'BRI-Signature: {{SIGNATURE}}' \ --header 'BRI-Timestamp: {{TIMESTAMP}}' \ --header 'Authorization: Bearer {{TOKEN}}' \ --data-raw '{ "reff_number": "123762", "amount": "1000", "card_number": "5221123456789101", "username": "John Doe" }'
Contoh Response
{ "status": { "code": "00", "desc": "SUCCESS" }, "brizzi": { "jenis_trx": "Top Up Pending" } }
HTTP Request
POST https://sandbox.partner.api.bri.co.id/v1/brizzi/topup/checktrx
Request Body
Field | Data Type | Max Char | Mandatory | Deskripsi |
---|---|---|---|---|
username | String | - | Yes | Nama pengguna yang digunakan pada aplikasi pihak ketiga (digunakan untuk rekonsiliasi) |
card_number | Numeric | 16 | Yes | Nomor kartu Brizzi yang akan diisi ulang |
amount | Numeric | 7 | Yes | Nominal top up |
reff_number | String | 30 | Yes | Nomor referensi yang digunakan untuk rekonsiliasi |
Response Body
Field | Data Type | Max Char | Mandatory | Deskripsi |
---|---|---|---|---|
status | ||||
code | String | 2 | Yes | Response status code |
desc | String | - | Yes | Response status description |
brizzi | ||||
jenis_trx | String | - | Yes | Transaction type |
Error Codes
Code | Code Description |
---|---|
51 | Saldo Tidak Cukup |
53 | Rekening Tidak ditemukan |
54 | KARTU EXPIRED |
62 | KARTU TIDAK AKTIF |
84 | ERROR DLL |
93 | Duplicate Reff Number |
94 | Trx doesn't Exists |
99 | ERROR DLL |
NF | KARTU TIDAK TERDAFTAR |
NV | INVALID NUMERIC VALUE |
OT | MELEBIHI LIMIT TOPUP |
OV | MELEBIHI LIMIT KARTU |
Q1 | KONEKSI TERPUTUS |
Q4 | KONEKSI TIME OUT |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan