BRIZZI

Buat API

Apa Itu Brizzi?

 

Jika dalam kurun waktu beberapa tahun yang lalu masyarakat masih banyak yang menggunakan uang tunai untuk bertransaksi, di era globalisasi ini masyarakat sudah mulai bergerak ke arah gaya hidup tanpa uang tunai atau yang disebut cashless. Hal tersebut dapat dilihat dari maraknya penggunaan uang elektronik berbasis chip untuk menjalani transaksi. BRI sendiri memiliki produk uang elektronik unggulan berbentuk kartu untuk melayani berbagai kebutuhan transaksi nasabah, yaitu BRIZZI.

Keuntungan dari penggunaan uang elektronik keluaran BRI ini adalah dapat diisi ulang melalui EDC ataupun ATM, digunakan di merchant yang telah bekerjasama dengan BRI, menikmati promo-promo BRIZZI yang variatif, serta mengakomodasi pembayaran transaksi mulai dari Rp 1,- sampai dengan Rp 2.000.000,-

Anda dapat mengimplementasikan fitur cek saldo dan isi ulang kartu BRIZZI pada bisnis digital Anda. Hal ini bisa direalisasikan melalui Open API dari BRI atau BRIAPI, dimana salah satu produk dari BRIAPI adalah API BRIZZI. Sebagai contoh, jika Anda memiliki bisnis digital yang bergerak di bidang e-commerce, Anda dapat memperkaya fitur aplikasi e-commerce Anda dengan API BRIZZI. Dengan begitu, nasabah Anda dapat melakukan cek saldo dan isi ulang kartu BRIZZI langsung dari aplikasi Anda.

Informasi API

Title BRIZZI

Version

v2.0

URL Sandbox

https://sandbox.partner.api.bri.co.id/

URL Production

 

Kendali Versi

Versi Dok

Versi API

Tanggal

Tautan Dokumen

Deskripsi

v1.0

v1.0

1 February 2019

Halaman Ini

Versi Awal
v2.0 v2.0 29 Agustus 2022 Halaman Ini Menghapus field request "reff" di fitur topup

 

Deskripsi Produk

Product Overview

API BRIZZI berisi 2 fitur yaitu topup deposit dan refund topup deposit.

 

Endpoint

A. Validate Card Number

Endpoint ini digunakan untuk memvalidasi apakah nasabah menggunakan nomor kartu BRIZZI yang valid atau tidak saat melakukan isi ulang.

General Information

HTTP Method

POST

Path

/v2.0/brizzi/checknum

Format Type

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Mandatory

Length

Deskripsi

Contoh

Authorization

Bearer {token}

M

N/A

Access Token

 

BRI-Timestamp

 

M

-

ISO 8601 format. Timestamp must be in UTC or GMT +0 timezone

2021-03-18T02:51:48.624Z

 

BRI-Signature

 

M

64

-

 

 

Content-Type

application/json

M

-

-

 

 
BRI-External-Id Numeric M 9 External ID, ex : 202002020001 (must unique)  

Request Structure

Field

Data Type

Mandatory

Length

Deskripsi

Contoh

username

String

M

 

 Nama pengguna yang digunakan pada aplikasi pihak ketiga

 

 test

 
brizziCardNo String M 16 Nomor kartu Brizzi yang akan diisi ulang 6013501000501402  

Response Structure

Field

Type Data

Mandatory

Length

Deskripsi

Contoh

responseCode

String

M

2

Response code

00

 
responseDescription

String

M

255

Response description

 SUCCESS

 

 

Request & Response Payload Sample

Request :

{
 "username": "test",
 "brizziCardNo": "6013500601496673"
}

Normal Response :

{
 "responseCode": "00",
 "responseDescription": "SUCCESS"
 }

Error Response :

{
 "responseCode": "NF",
 "responseDescription": "Nomor Kartu Tidak Terdaftar"
 }

 

List of Error/Response Code

HTTP Status

Response Code

Status

Response Deskripsi

Deskripsi

200

00

Success

 SUCCESS

Validate Card Number Success

200

54

Failed

 KARTU EXPIRED

Validate Card Number Failed

200

62

Failed

 KARTU TIDAK AKTIF

Validate Card Number Failed

200

64

Failed

 ERROR DLL

Validate Card Number Failed

200

NF

Failed

Nomor Kartu Tidak Terdaftar

Validate Card Number Failed

B. Topup Deposit

Endpoint Description
Endpoint ini berfungsi untuk melakukan topup deposit pada kartu BRIZZI. Saldo BRIZZI akan tersimpan dan diperbarui pada backend BRIZZI

General Information

HTTP Method

POST

Path

/v2.0/brizzi/topup

Format Type

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Mandatory

Length

Deskripsi

Contoh

Authorization

Bearer {token}

M

N/A

Access Token

 

BRI-Timestamp

 

M

-

ISO 8601 format. Timestamp must be in UTC or GMT +0 timezone

2021-03-18T02:51:48.624Z

 

BRI-Signature

 

M

64

-

 

 

Content-Type

application/json

M

-

-

 

 
BRI-External-Id Numeric M 9 External ID, ex : 202002020001 (must unique)  

Request Structure

Field

Data Type

Mandatory

Length

Deskripsi

Contoh

username

String

M

 

 Username

 

 test

 
brizziCardNo String M 16 Nomor Kartu 6013501000501402  
amount String M 7 Amount Topup Pending 5123.00  

Response Structure

Field

Type Data

Mandatory

Length

Deskripsi

Contoh

errorCode

String

M

10

 Error Code BZ-00

 
responseCode

String

M

2

 Response code 00

 
responseDescription String M 255 Response description Transaction Successfully  
data Object M - JSON Object -  
brizziCardNo String O 16 Nomor Kartu 6013501000501402  
pendingBalance String M 255 Amount Pending Balance 14045  
reff String M 9 Reference / Unique number yang dikirim dari Merchant 13650  

 

Request & Response Payload Sample

Request :

{
 "username": "test_topup",
 "brizziCardNo": "6013500601505515",
 "amount": "5123.00"
 }

Normal Response :

{
 "errorCode": "BZ-00",
 "responseCode": "00",
 "responseDescription": "Transaction Successfully",
 "data": {
 "reff": "119011",
 "pendingBalance": 9998948
 }
}

Error Response :

{
 "errorCode": "ESB-001",
 "responseCode": "001",
 "responseDescription": "Unknown Account Type"
}

 

List of Error/Response Code

HTTP Status

Error Code

Response Code

Status

 Response Deskripsi Deskripsi

200

BZ-00

00

 Success Sukses Topup Deposit Success

200

 BZ-54

54

 Failed

Kartu Expired

 Topup Deposit Failed

200

BZ-62

62

 Failed Card Inactive Topup Deposit Failed

200

BZ-93

93

 Failed Duplicate Reff Number Topup Deposit Failed

200

BZ-99

99

 Failed Error tidak terdefinisi Topup Deposit Failed
200 BZ-EV EV Failed Empty Variable Topup Deposit Failed
200 BZ-NF NF Failed Card Number / Original Transaction Not Found Topup Deposit Failed
200 BZ-OT OT Failed Over Topup Monthly (20Jt) Topup Deposit Failed
200 BZ-OV OV Failed Over Card Limit (10Jt) Topup Deposit Failed
200 BZ-Q1 Q1 Suspend Koneksi antar Host Terputus Need Chenking
200 BZ-Q4 Q4 Suspend Koneksi Time Out Need Chenking
200 BZ-ER ER Failed Error Data Type/Invalid Message Format Topup Deposit Failed
200   0902 Suspend Unexpected Error Need Chenking

C. Check Top Up Status

Endpoint Description
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.

General Information

HTTP Method

POST

Path

/v2.0/brizzi/checktrx

Format Type

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Mandatory

Length

Deskripsi

Contoh

Authorization

Bearer {token}

M

N/A

Access Token

 

BRI-Timestamp

 

M

-

ISO 8601 format. Timestamp must be in UTC or GMT +0 timezone

2021-03-18T02:51:48.624Z

 

BRI-Signature

 

M

64

-

 

 

Content-Type

application/json

M

-

-

 

 
BRI-External-Id Numeric M 9 Unique    

Request Structure

Field

Data Type

Mandatory

Length

Deskripsi

Contoh

username

String

M

79

 Nama pengguna yang digunakan pada aplikasi pihak ketiga (digunakan untuk rekonsiliasi)

 

 Test

 
brizziCardNo String M 9 Nomor kartu Brizzi yang akan diisi ulang 6013500601496673  
amount String M 7 Nominal top up 1000  
reff String M 30 BRI External ID topup deposit 135600  

Response Structure

Field

Type Data

Mandatory

Length

Deskripsi

Contoh

responseCode

String

M

2

 Response code 00

 
responseDescription

String

M

255

 Response description Transaction Successfully

 
data Object M - JSON Object -  
jenisTrx String M 16 Nomor Kartu 6013501000501402  
reversal String M 6 Nomor reference    

 

Request & Response Payload Sample

Request :

{
 "username": "Tito",
 "brizziCardNo": "6013500601496673",
 "amount": "10",
 "reff": "1356040"
}

Normal Response :

{
 
 "responseCode": "00",
 "responseDescription": "TRANSAKSI SUKSES",
 "data": {
 "jenisTrx": "",
 "reversal": "FALSE"
 }
}

Error Response :

{
 "responseCode": "94",
 "responseDescription": "Trx doesn't Exists"
}

 

List of Error/Response Code

HTTP Status

Response Code

Status

 Response Deskripsi Deskripsi

200

00

 Success TRANSAKSI SUKSES Check Transaction Success

200

94

 Failed Trx doesn't Exists Check Transaction Failed

200

99

 Pending ERROR DLL Check Transaction Pending

200

OT

 Failed MELEBIHI LIMIT TOPUP Check Transaction Failed

200

OV

 Failed MELEBIHI LIMIT KARTU Check Transaction Failed
200 Q1 Failed KONEKSI TERPUTUS Check Transaksi Failed
200 Q4 Failed KONEKSI TIME OUT Check Transaksi Failed