BRIZZI
What is BRIZZI?
Digital revolution has led people to go cashless. Consumers now prefer digital payment options over cash, and this lifestyle has increased the popularity of chip-based e-money for transactions.
As the largest bank in Indonesia, BRI has its own e-money product for all kinds of transactions, named BRIZZI. BRIZZI accommodates payment transactions with values from Rp1 to Rp2.000.000. BRIZZI can be topped-up through EDC or ATM, can be used in BRI-partnered merchants, and customers can enjoy various promotions.
You can implement BRIZZI features into your digital apps through BRIZZI API in BRIAPI. With this API, customers can check their BRIZZI balance and top-up directly from your app. In addition, customers may also use BRIZZI for payments in your digital apps. This will enrich your payment options, especially if you run e-commerce business.
API Information
| Title | BRIZZI |
|---|---|
|
Version |
v2.0 |
|
URL Sandbox |
https://sandbox.partner.api.bri.co.id/ |
|
URL Production |
|
Version Control
|
Versi Doc |
Versi API |
Date |
Link to document |
Description |
|---|---|---|---|---|
|
>v1.0 |
>v1.0 |
>1 February 2019 |
this pages |
Baseline version. |
| v2.0 | v2.0 | 29 Agustus 2022 | this pages | Removing the "reff" field request in the refill feature |
Product Description
Product Overview
BRIZZI API contains 2 features which are topup deposit and refund topup deposit.
Endpoint
A. Validate Card Number
This endpoint is used to validate whether the customer is using a valid BRIZZI card number or not when topping up.
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 |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
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 |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
username |
String |
M |
|
Username used in third applications
|
test |
|
| brizziCardNo | String | M | 16 | Brizzi card number to be topped up | 6013501000501402 |
Response Structure
|
Field |
Type Data |
Mandatory |
Length |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
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": "Unregistered Card Number"
}
List of Error/Response Code
|
HTTP Status |
Response Code |
Status |
Response Description |
Description |
|---|---|---|---|---|
|
200 |
00 |
Success |
SUCCESS |
Validate Card Number Success |
|
200 |
54 |
Failed |
EXPIRED CARDS |
Validate Card Number Failed |
|
200 |
62 |
Failed |
INACTIVE CARD |
Validate Card Number Failed |
|
200 |
64 |
Failed |
ERROR ETC |
Validate Card Number Failed |
|
200 |
NF |
Failed |
Unregistered Card Numbe |
Validate Card Number Failed |
B. Topup Deposit
Endpoint Description
This endpoint serves to topup the deposit on the BRIZZI card. The BRIZZI balance will be stored and updated on the BRIZZI backend.
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 |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
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 |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
username |
String |
M |
|
Username
|
test |
|
| brizziCardNo | String | M | 16 | Card Number | 6013501000501402 | |
| amount | String | M | 7 | Amount Topup Pending | 5123.00 |
Response Structure
|
Field |
Type Data |
Mandatory |
Length |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
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 | Card Number | 6013501000501402 | |
| pendingBalance | String | M | 255 | Amount Pending Balance | 14045 | |
| reff | String | M | 9 | Reference / Unique number sent from 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 Description | Description |
|---|---|---|---|---|---|
|
200 |
BZ-00 |
00 |
Success | Sukses | Topup Deposit Success |
|
200 |
BZ-54 |
54 |
Failed |
Expired Card |
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 | Undefined error | 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 | Connection between Hosts Disconnected | Need Chenking |
| 200 | BZ-Q4 | Q4 | Suspend | Connection 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
This endpoint is used to check the status of refills that have been performed. Usually this endpoint is used when you make a refill request, But you do not get a response from 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 |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
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 |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
username |
String |
M |
79 |
Username used in third party application (used for reconciliation)
|
Test |
|
| brizziCardNo | String | M | 9 | Brizzi card number to be topped up | 6013500601496673 | |
| amount | String | M | 7 | Top up amount | 1000 | |
| reff | String | M | 30 | BRI External ID topup deposit | 135600 |
Response Structure
|
Field |
Type Data |
Mandatory |
Length |
Description |
Example |
|
|---|---|---|---|---|---|---|
|
responseCode |
String |
M |
2 |
Response code | 00 |
|
| responseDescription |
String |
M |
255 |
Response description | Transaction Successfully |
|
| data | Object | M | - | JSON Object | - | |
| jenisTrx | String | M | 16 | Number Card | 6013501000501402 | |
| reversal | String | M | 6 | Number 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 Description | Description |
|---|---|---|---|---|
|
200 |
00 |
Success | SUCCESSFUL TRANSACTION | Check Transaction Success |
|
200 |
94 |
Failed | Trx doesn't Exists | Check Transaction Failed |
|
200 |
99 |
Pending | ERROR ETC | Check Transaction Pending |
|
200 |
OT |
Failed | EXCEEDING THE TOPUP LIMIT | Check Transaction Failed |
|
200 |
OV |
Failed | EXCEEDING THE CARD LIMIT | Check Transaction Failed |
| 200 | Q1 | Failed | LOST CONNECTION | Check Transaksi Failed |
| 200 | Q4 | Failed | CONNECTION TIMEOUT | Check Transaksi Failed |
