Tarik Tunai Tanpa Kartu
Informasi API
Title |
Tarik Tunai Tanpa Kartu |
---|---|
Version |
v1.0 |
URL Sandbox |
Disediakan oleh Partner |
URL Production |
Kendali Versi
Versi Dok |
Versi API |
Tanggal |
Tautan dokumen |
Deskripsi |
---|---|---|---|---|
v1.0 |
v1.0 |
11 Oktober 2021 |
Halaman ini. |
Versi awal |
Deskripsi Produk
Gambaran Umum Produk
Merupakan produk API yang disediakan oleh BRI dan pihak ketiga (partner bisnis BRI) yang memungkinkan nasabah BRI dapat melakukan tarik tunai tanpa kartu di ATM BRI melalui aplikasi pihak ketiga. Pihak ketiga dapat membuat API berdasarkan spesifikasi berikut pada sistem pihak ketiga sehingga BRI dapat melakukan pemanggilan API.
Endpoint
A. Auth Token
Deskripsi Endpoint
API Cardless Withdrawal Get Token untuk mendapatkan token Oauth2.0 guna melakukan pembuatan signature.
Informasi Umum
HTTP Method |
POST |
---|---|
Path |
http://{base_url_partner}/v1/cardless/token |
Tipe Format |
JSON |
Authentication |
- |
Struktur Header
Key |
Value |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
Content-Type |
application/json |
M |
- |
- |
- |
Struktur Request
Field |
Tipe Data |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
providerId |
String |
M |
- |
||
secretKey |
String |
M |
- |
Struktur Respon
Field |
Tipe Data |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
accessToken |
String |
M |
- |
- |
|
responseCode |
String |
M |
- |
||
responseMessage |
String |
M |
- |
||
expiredIn |
String |
M |
- |
Masa berlaku token dalam hitungan detik |
Contoh Payload Request dan Respon
Request :
{ "providerId":"QwErTy123", "secretKey":"PoIuY098" }
Respon Normal :
{ "responseCode":"00", "responseMessage":"success", "accessToken":"lfbo1985ujlnbviovQOUB12oifnfiqIO", "expiredIn":"180" }
Respon Error :
{ "responseCode":"01" "responseMessage":"Invalid providerId or secretKey" }
Daftar Error/Kode Respon
HTTP Status |
Kode |
Status |
Deskripsi Respon |
Deskripsi |
---|---|---|---|---|
200 |
00 |
Sukses |
Success |
Sukses jika mendapatkan RC 00, selain itu gagal |
400 |
01 |
Gagal |
Invalid providerId or secretKey |
Transaksi Gagal |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan
B. Cardless Withdrawal
Deskripsi Endpoint
API Cardless Withdrawal merupakan API yang digunakan untuk melakukan update data ke pihak ke-3 untuk proses tarik tunai di ATM.
Informasi Umum
HTTP Method |
POST |
---|---|
Path |
http://{base_url_partner}/v1/cardless/withdrawal |
Tipe Format |
JSON |
Autentikasi |
Bearer Token |
Struktur Header
Key |
Nilai |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
signature |
signature |
M |
- |
Signature
|
|
timestamp |
ISO 8601 |
- |
|||
Content-Type |
application/json |
M |
- |
- |
- |
Struktur Request
Field |
Tipe Data |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
token |
String |
M |
9 |
Kode OTP |
|
msisdn |
String |
M |
13 |
Nomor Virtual Account |
|
merchantTrxID |
String |
M |
25 |
Merchant transaction ID |
Struktur Respon
Field |
Tipe Data |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
responseKode |
String |
M |
2 |
Kode Respon |
- |
responseMessage |
String |
M |
50 |
Deskripsi Respon |
|
msisdn |
String |
M |
13 |
Nomor virtual account |
|
amount |
String |
M |
22 |
Nominal transaksi |
|
trxDate |
String |
M |
23 |
Tanggal transaksi (format: yyyy-MM-dd HH:mm:ss.fff) |
|
merchantTrxID |
String |
M |
25 |
Merchant transaction ID, unik untuk setiap transaksi |
|
linkRefNum |
String |
M |
25 |
Nomor referensi |
Request :
{ "token":"9203310116", "msisdn":"8118821681", "merchantTrxID":"1000000007" }
Respon Normal :
{ "responseCode":"00", "responseMessage":"success", "msisdn":"8118821681", "amount":"50000.00", "trxDate":"2019-10-14 15:20:40.043", "merchantTrxID":"0000000007", "linkRefNum":"5GP7L02UR75GP7L02UR7" }
Respon Error:
{ "responseCode":"14", "responseMessage":"virtual account not found" }
Daftar Error / Kode Respon
HTTP Status |
Kode |
Status |
Deskripsi Respon |
Deskripsi |
---|---|---|---|---|
200 |
00 |
Sukses |
success |
Sukses jika mendapatkan RC 00, selain itu gagal |
400 |
12 |
Gagal |
Invalid Request/Unauthorized/Invalid Signature |
Transaksi Gagal |
400 |
14 |
Gagal |
Virtual Account Not Found |
Transaksi Gagal |
400 |
16 |
Gagal |
Token Expired |
Transaksi Gagal |
400 |
18 |
Gagal |
Insufficient Balance |
Transaksi Gagal |
400 |
20 |
Gagal |
Duplicate Transaction Id |
Transaksi Gagal |
400 |
68 |
Gagal |
Timeout |
Transaksi Gagal |
400 |
99 |
Gagal |
Undefined Error |
Transaksi Gagal |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan
C. Cardless Reversal
Deskripsi Endpoint
API Cardless Reversal merupakan API yang digunakan untuk melakukan reversal ke pihak ke-3 jika terjadi kegagalan saat proses tarik tunai.
Informasi Umum
HTTP Method |
POST |
---|---|
Path |
http://{base_url_partner}/v1/cardless/reversal |
Tipe Format |
JSON |
Autentikasi |
Bearer Token |
Struktur Header
Key |
Nilai |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
signature |
signature |
M |
- |
Signature
|
|
timestamp |
ISO 8601 |
- |
|||
Content-Type |
application/json |
M |
- |
- |
- |
Struktur Request
Field |
Tipe Data |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
token |
String |
M |
9 |
Kode OTP |
|
msisdn |
String |
M |
18 |
Nomor Virtual Account |
|
merchantTrxID |
String |
M |
25 |
Merchant transaction ID |
|
amount |
String |
O |
22 |
Nominal transaksi |
|
trxDate |
String |
O |
23 |
Tanggal transaksi (Format: yyyy-MM-dd HH:mm:ss.fff) |
Struktur Respon
Field |
Tipe Data |
Mandatory |
Panjang |
Deskripsi |
Contoh |
---|---|---|---|---|---|
responseKode |
String |
M |
2 |
Response Kode |
- |
responseMessage |
String |
M |
50 |
Response message |
|
msisdn |
String |
M |
18 |
Nomor virtual account |
|
amount |
String |
O |
22 |
Nominal transaksi |
|
trxDate |
String |
O |
23 |
Tanggal transaksi (format: yyyy-MM-dd HH:mm:ss.fff) |
|
merchantTrxID |
String |
M |
25 |
Merchant transaction ID, unik untuk setiap transaksi |
Request & Response Payload Sample
Request type:
{ "token": "999995678", "amount": "10000.00", "msisdn": "0816789012", "merchantTrxID": "000777", "trxDate": "2019-10-14 15:20:40.043" }
Normal Response :
{ "responseCode": "00", "responseMessage": "success", "amount": "10000.00", "msisdn": "0816789012", "merchantTrxID": "000777", "trxDate": "2019-10-16 15:20:40.043" }
Error Response :
{ "responseCode":"14", "responseMessage":"virtual account not found" }
Daftar Error / Kode Respon
HTTP Status |
Kode |
Status |
Response Deskripsi |
Deskripsi |
---|---|---|---|---|
200 |
00 |
Sukses |
success |
Sukses jika mendapatkan RC 00, selain itu gagal |
400 |
12 |
Gagal |
Invalid Request/Unauthorized/Invalid Signature |
Reversal Gagal |
400 |
14 |
Gagal |
Virtual Account Not Found |
Reversal Gagal |
400 |
22 |
Gagal |
Original Transaction Id not Found |
Reversal Gagal |
400 |
68 |
Gagal |
Timeout |
Reversal Gagal |
400 |
99 |
Gagal |
Undefined Error |
Reversal Gagal |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan