APIDOCS Direct Debit SNAP BI
API Information
Title | API Transfer Debit SNAP BI - API Direct Debit |
---|---|
Version | v2.0 |
URL Sandbox | https://sandbox.partner.api.bri.co.id |
URL Production |
Document Version Control
Doc Version | API Version | Tanggal | Link Dokumen | Deskripsi |
---|---|---|---|---|
v1.0 | v1.0 | 02 Des 2021 | Disini | Baseline version. |
v1.1 |
v2.0 |
19 Feb 2024 |
Halaman ini |
Update Details :
|
Product Description
Catatan: OTP dan Notif (Binding dan Payment) yang sebelumnya dikirimkan melalui SMS akan dikirimkan melalui Whatsapp
Gambaran Produk
API Transfer Debit digunakan untuk melakukan pemindahanbukuan dana dari satu rekening ke rekening lain baik dalam PJP AIS yang sama maupun PJP AIS yang berbeda yang diinisiasi oleh pihak penerima.
Remark Rekening Koran
16 karakter (DRDBT/DRRFN+5 digit kode partner+2 digit kode transaksi+4 digit terakhir kartu)+spasi+12 digit paymentid+spasi+10 karakter trx_id partner yang diambil dari partnerReferenceNo.
Header
Key |
Value |
Format |
Mandatory |
Length |
Deskripsi |
---|---|---|---|---|---|
Authorization |
Authorization |
Alphanumeric |
M |
|
Bearer {Token} |
X-TIMESTAMP |
BRI - timestamp |
Datetime |
M |
|
Format Timestamp ISO8601 |
X-SIGNATURE |
BRI - Signature |
Alphanumeric |
M |
|
HMAC_SHA512 |
Content-Type |
application/json |
Alpha |
M |
|
application/json |
X-PARTNER-ID |
|
Alphanumeric |
M |
36 |
|
CHANNEL-ID |
|
Alpha |
M |
5 |
|
X-EXTERNAL-ID |
|
Numeric |
M |
36 |
|
Endpoint
A. Direct Debit Payment
Endpoint ini digunakan untuk pembayaran dari transaksi berdasarkan nomor kartu pada card_token yang diperoleh dari proses binding (pembuatan token kartu).
Catatan : OTP dan Notif (Binding dan Payment) yang sebelumnya dikirimkan melalui SMS akan dikirimkan melalui Whatsapp
General Information
HTTP Method |
POST |
---|---|
Path |
|
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
partnerReferenceNo |
String |
Alphanumeric |
M |
64 |
Identifikasi transaksi pada sistem layanan konsumen |
213423121521232 |
urlParam |
Array of Object |
|
O |
|
|
|
>url |
String |
Alphanumeric |
M |
512 |
URL for callback |
http://iniurl. com |
>type |
String |
Alpha |
M |
32 |
URL Type PAY_RETURN/PAY _NOTIFY |
PAY_NOTIFY |
>isDeepLink |
String |
Alpha |
M |
1 |
Apakah URL tersebut adalah deeplink URL atau bukan Y/N |
N |
amount |
Object |
|
O |
|
|
|
>value |
String (ISO4217) |
Numeric |
M |
15,2 Note : SNAP BI Length (16,2) |
Jumlah transaksi yang akan dibayarkan menggunakan metode pembayaran ini apabila dalam rupiah maka nilainya termasuk 2 digit desimal. misalnya RP 10.000, akan ditempatkan dengan 10000.00 |
12345678.00 |
>currency |
String |
Alpha |
M |
3 |
Mata Uang |
IDR |
chargeToken |
String |
Alphanumeric |
M |
40 |
kode string untuk verifikasi OTP |
abcd63617264746f6b656e |
bankCardToken |
String |
|
M Note : SNAP BI (O) |
560 Note : SNAP BI Length (128) |
|
0000710001 0926 |
additionalInfo |
Object |
|
O |
|
Informasi Tambahan |
|
>otpStatus |
String |
Alpha |
M |
3 |
|
|
>settlementAccount |
String |
Numeric |
M |
16 |
|
|
>merchantTrxId |
String |
Alpha |
O |
64 |
|
|
>remarks | String | Alphanumeric | O | 64 | Remark transaksi yang akan disertakan di report |
Response Structure & Sample (OTP)
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Respon Kode |
2005400 |
responseMessage |
String |
Alpha |
M |
150 |
Respon Deskripsi |
Successful |
referenceNo |
String |
Numeric |
M Note : SNAP BI (C) |
64 |
Identifikasi transaksi pada sistem layanan konsumen |
2020102900 0000000000 01 |
partnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi pada sistem penyedia layanan. Harus diisi setelah transaksi berhasil |
test-2020102977 7700000000 09 |
additionalInfo |
Object |
|
O |
|
Informasi Tambahan |
|
>chargeToken |
String |
Alphanumeric |
M |
50 Note : SNAP BI Length (40) |
|
|
>merchantTrxId |
String |
Alphanumeric |
O |
64 |
|
|
>remarks |
String |
Alphanumeric |
O |
64 |
Remark transaksi yang akan disertakan di report |
|
Response Structure & Sample (without OTP)
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Respon Kode |
2005400 |
responseMessage |
String |
Alpha |
M |
150 |
Respon Deskripsi |
Successful |
partnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi pada sistem layanan konsumen |
213423121521232 |
referenceNo |
String |
Numeric |
M Note : SNAP BI (C) |
64 |
Identifikasi transaksi pada sistem penyedia layanan. Harus diisi setelah transaksi berhasil |
2020102977 7700000000 09 |
additionalInfo |
Object |
|
O |
|
Informasi Tambahan |
|
>amount |
String |
Numeric |
M |
15,2 Note : SNAP BI Length (16,2) |
Jumlah transaksi yang akan dibayarkan menggunakan metode pembayaran ini apabila dalam rupiah maka nilainya termasuk 2 digit desimal. misalnya RP 10.000, akan ditempatkan dengan 10000.00 |
2000.00 |
>currency |
String |
Alpha |
M |
3 |
Mata Uang |
IDR |
>merchantTrxId |
String |
Alphanumeric |
O |
64 |
|
|
>remarks |
String |
Alphanumeric |
O |
64 |
Remark transaksi yang akan disertakan di report |
|
Request & Response Payload Sample
Request :
{ "partnerReferenceNo":"426306015176", "urlParam":[ { "url":"https://5fdc5f1948321c00170119e0.mockapi.io/api/v1/simulation/simulation", "type":"PAY_NOTIFY", "isDeepLink":"N" } ], "amount":{ "value":"10000.00", "currency":"IDR" }, "chargeToken":"null", "bankCardToken":"card_.eyJpYXQiOjE3MDgwNTAzNTYsImlzcyI6IkJhbmsgQlJJIC0gRENFIiwianRpIjoiNmY2MmE4ZjUtMGUwMS00NjFjLWJlZmQtYjk3ZWE5YjNmMmIwIiwicGFydG5lcklkIjoi77-9Iiwic2VydmljZU5hbWUiOiJERF9FWFRFUk5BTF9TRVJWSUNFIn0.HR4P9PecyfCZLJ-ibeuxuuWtHzWHrzgunjxiEQJZEjZHO2fQqrMgaO8IUnmACtNJilGOpIQAc7Jsa5W_tCF4KmIpC5jB-tDw40tpqImZ9Famt_hzgacrDcByw2jT9UAPMH444kGAQa7z44PV6jcHdQoaIAfiOkChHw-b11Vg4LyETbsEExvOcL2hKomG_JXpDq5bYmuHcJ2SJ8lRnGomi-7oz_dyM0_wUe1fmE6UyLnvEFz6o6q8nXtm_3g29cLP_4uw5BT54DuSXrRdmw4J7PK3zl2qUnM7CBpYVRLr74iCx9SLGYIMMROE7aGe_DkNfK-dnLKgcvIaN0q-rnLbhg", "additionalInfo":{ "otpStatus":"NO", "settlementAccount":"020601000109305", "merchantTrxId":"", "remarks":"test remark 1" } }
Normal Response ( OTP ):
{ "responseCode":"2005400", "responseMessage":"Successful", "referenceNo":"84191395354248915228", "partnerReferenceNo":"213423121521232", "additionalInfo":{ "chargeToken":"7KNSxmbcMjD16aP", "merchantTrxId":"", "remarks":"" } }
Normal Response ( without OTP ):
{ "responseCode":"2005400", "responseMessage":"Successful", "referenceNo":"673331266487", "partnerReferenceNo":"426306015176", "additionalInfo":{ "amount":"10000.00", "currency":"IDR", "merchantTrxId":"", "remarks":"test remark 1" } }
Error Response :
{ "responseCode": "4035418", "responseMessage": "Inactive Account" }
List of Error/Response Code
HTTP Status |
Service Code |
Case Code |
Status |
Response Description |
Deskripsi |
---|---|---|---|---|---|
200 |
54 |
00 |
Sukses |
Successful |
|
400 |
54 |
00 |
Gagal |
Bad Request |
|
400 |
54 |
01 |
Gagal |
Invalid Field Format value |
|
401 |
54 |
01 |
Gagal |
B2B2C Access Token Invalid/Expired |
Token found in request is invalid (Access Token Not Exist, Access Token Expiry) |
403 |
54 |
02 |
Gagal |
Exceeds Transaction Amount Limit |
Melebihi batas jumlah transaksi |
403 |
54 |
03 |
Gagal |
Suspected Fraud |
|
403 |
54 |
05 |
Gagal |
Inactive Card/Account/Customer |
Menunjukan akun tidak aktif |
403 |
54 |
08 |
Gagal |
Card Expired |
|
403 |
54 |
14 |
Gagal |
Insufficient Funds |
Dana Tidak Mencukupi |
403 |
54 |
15 |
Gagal |
Transaction Not Permitted.[Reason] |
-Transaction Not Permitted. Invalid settlementAccount (settlementAccount bukan rekening BRI / bukan rekening Giro) -Transaction Not Permitted. Duplicate merchantTrxId (merchantTrxId sudah pernah digunakan) -Transaction Not Permitted. Failed Process (Transaksi yang dilakukan gagal) |
403 |
54 |
18 |
Gagal |
Inactive Account |
|
404 |
54 |
11 |
Gagal |
Card Token Invalid |
|
404 |
54 |
13 |
Gagal |
Invalid Amount |
Jumlah tidak sesuai dengan yang seharusnya |
409 |
54 |
00 |
Gagal |
Conflict |
Tidak dapat menggunakan X-EXTERNAL-ID yang sama dihari yang sama |
409 |
54 |
01 |
Gagal |
Duplicate partnerReferenceNo |
partnerReferenceNo sudah pernah digunakan |
429 |
54 |
00 |
Gagal |
To Many Request |
|
500 |
54 |
00 |
Gagal |
General Error |
|
504 |
54 |
00 |
Pending |
Timeout |
Timeout from the issuer (Check in report H+1) |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan.
B. Payment Status
Endpoint ini digunakan untuk memberikan status dari payment
Catatan: Payment status dapat menggunakan "originalPartnerReferenceNo" atau "originalReferenceNo". salah satunya harus diisi walau keduanya optional
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v2.0/debit/status |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
originalPartnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
2020102900000000000001
|
originalReferenceNo |
String |
Numeric |
O |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan |
2020102977770000000009 |
serviceCode |
String |
Numeric |
M |
2 |
Indikator jenis transaksi (kode layanan dari permintaan transaksi asli) |
54 |
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Respon Kode |
2005500 |
responseMessage |
String |
Alpha |
M |
150 |
Respon Deskripsi |
Successful |
originalPartnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
2020102900000000000001 |
originalReferenceNo |
String |
Numeric |
O Note: SNAP BI (C) |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan. Harus diisi setelah transaksi berhasil |
2020102977770000000009 |
serviceCode |
String |
Numeric |
M |
2 |
Indikator jenis transaksi (kode layanan dari permintaan transaksi asli) |
17 |
latestTransactionStatus |
String |
Numeric |
M |
2 |
00 - Success 03 - Pending 06 - Failed |
00 |
transactionStatusDesc |
String |
Alpha |
M Note: SNAP BI (O) |
7 Note : SNAP BI length (50) |
Deskripsi status transaksi |
success |
originalResponseCode |
String |
Numeric |
O |
7 |
Respon kode |
2005500 |
refundHistory |
Array of Object |
|
O |
|
|
|
>partnerRefundNo |
String |
Numeric |
M |
64 |
Nomor referensi dari PJP AIS untuk pengembalian dana |
2398509182 0498120597 0 |
>refundAmount |
Object |
|
O |
|
|
|
>>value |
String (ISO4217) |
Numeric |
M |
15,2 Note : SNAP BI Length (16,2) |
Jumlah bersih pengembalian dana |
12345678.0 0 |
>>currency |
String |
Alpha |
M |
3 |
Mata Uang |
IDR |
>refundStatus |
String |
Numeric |
M |
2 |
00 - Success 06 - Failed |
00 |
>refundDate |
String |
Datetime |
M Note: SNAP BI (C) |
25 |
(ISO 8601) Tanggal transaksi : dd-MMyyyy |
2020-12- 23T07:44:16 +07:00 |
>reason |
String |
Alpha |
M Note: SNAP BI (O) |
255 Note : SNAP BI length (256) |
Alasan pengembalian dana |
Customer complain |
Request & Response Payload Sample
Request :
{ "originalPartnerReferenceNo":"815027979003", "originalReferenceNo":"574929794216", "serviceCode":"54" }
Normal Response :
{ "responseCode":"2005500", "responseMessage":"Successful", "originalPartnerReferenceNo":"815027979003", "originalReferenceNo":"574929794216", "latestTransactionStatus":"00", "transactionStatusDesc":"SUCCESS", "originalResponseCode":"2005400" }
Error Response :
{ "responseCode": "4045501", "responseMessage": "Transaction Not Found" }
List of Error/Response Code
HTTP Status |
Service Code |
Case Code |
Status |
Response Message |
Deskripsi |
---|---|---|---|---|---|
200 |
55 |
00 |
Sukses |
Successful |
|
400 |
55 |
01 |
Gagal |
Invalid Field Format [field request] |
|
400 |
55 |
02 |
Gagal |
Invalid Mandatory Field [field request] |
|
404 |
55 |
01 |
Gagal |
Transaction Not Found |
|
409 |
55 |
00 |
Gagal |
Conflict |
|
500 |
55 |
00 |
Gagal |
General Erorr |
|
504 |
55 |
00 |
Pending |
Timeout |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan
C. Payment Notify
Endpoint ini digunakan untuk memberikan notifikasi dari payment status.
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v2.0/debit/notify |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
originalPartnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
2020102900000000000001 |
originalReferenceNo |
String |
Numeric |
M |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan. |
2020102977770000000009 |
amount |
Object |
|
O |
|
|
|
>value |
String |
Numeric |
M |
15,2 Note : SNAP BI Length (16,2) |
Jumlah transaksi yang akan dibayarkan menggunakan metode pembayaran ini apabila dalam rupiah maka nilainya termasuk 2 digit desimal. misalnya RP 10.000, akan ditempatkan dengan 10000.00 |
12345678.0 0 |
>currency |
String (ISO4217) |
Alpha |
M |
3 |
Mata Uang |
IDR |
latestTransactionStatus |
String |
Numeric |
M |
2 |
00 - Success 03 - Pending 06 - Failed |
00 |
transactionStatusDescription |
String |
Alpha |
O |
50 |
Description status transaction |
success |
additionalInfo |
Object |
|
O |
|
|
|
>merchantTrxid |
String |
Alphanumeric |
O |
64 |
|
30220107504 |
>refundId |
String |
Numeric |
O |
64 |
|
528786398613 |
>remarks |
String |
Alphanumeric |
O |
64 |
Remark transaksi yang akan disertakan di report |
|
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Respon Kode |
2005600 |
responseMessage |
String |
Alpha |
M |
150 |
Respon Deskripsi |
Successful |
Request & Response Payload Sample
Request (Merchant) :
{ "originalPartnerReferenceNo":"202010290000000000056", "originalReferenceNo":"2020102900000000000009", "amount":{ "value":"10000.00", "currency":"IDR" }, "latestTransactionStatus":"00", "transactionStatusDesc":"success", "additionalInfo":{ "merchantTrxid":"30220107504", "remarks":"" } }
Request (Refund) :
{ "originalPartnerReferenceNo":"202010290000000000056", "originalReferenceNo":"2020102900000000000009", "amount":{ "value":"10000.00", "currency":"IDR" }, "latestTransactionStatus":"00", "transactionStatusDescription":"success", "additionalInfo":{ "refundId":"528786398613" } }
Normal Response :
{ "responseCode":"2005600", "approvalCode":"7d3923bd03054c15", "responseMessage":"Successful" }
Error Response :
{ "responseCode": "4045601", "responseMessage": "Transaction Not Found" }
List of Error/Response Code
HTTP Status |
Service Code |
Case Code |
Status |
Response Message |
Deskripsi |
---|---|---|---|---|---|
200 |
56 |
00 |
Success |
Successful |
|
500 | 56 | 00 | Gagal | General Error |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan.
D. Refund Payment
Endpoint ini digunakan untuk membuat permintaan pengembalian dana untuk pembayaran yang sebelumnya berhasil. Pengembalian dana dapat dilakukan dengan jumlah penuh atau sebagian.
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v2.0/debit/refund |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
originalPartnerReferenceNo |
String |
Alphanumeric |
M |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
2020102900000000000001 |
originalReferenceNo |
String |
Numeric |
M Notes : SNAP BI (O) |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan. |
2020102977 7700000000 09 |
partnerRefundNo |
String |
Numeric |
M |
64 |
Nomor referensi dari PJP AIS untuk pengembalian dana |
2398509182 0498120597 0 |
refundAmount |
Object |
|
O |
|
|
|
>value |
String |
Numeric |
M |
15,2 Note : SNAP BI Length (16,2) |
Jumlah bersih pengembalian dana. Jika itu IDR maka nilainya termasuk 2 angka desimal. misalnya Rp 10.000, akan ditempatkan dengan 10000.00 |
10000.00 |
>currency |
String |
Alpha |
M |
3 |
Mata Uang |
IDR |
reason |
String |
Alphanumeric |
O |
256 |
Alasan pengembalian |
Customer complain |
additionalInfo |
Object |
|
O |
|
|
|
>callbackUrl |
String |
Alphanumeric |
O |
512 |
|
|
>settlementAccount |
String |
numeric |
M |
16 |
|
|
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Respon Kode |
2005400 |
responseMessage |
String |
Alpha |
M |
150 |
Respon Deskripsi |
Request has been processed successfully |
originalReferenceNo |
String |
Numeric |
M |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
2020102977770000000009 |
originalPartnerReferenceNo |
String |
Alphanumeric |
M Note : SNAP BI (O) |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan |
2020102900000000000001 |
refundNo |
String |
Numeric |
M |
64 |
Nomor referensi dari PJP AIS untuk pengembalian dana |
2398509182 04981205970 |
partnerRefundNo |
String |
Numeric |
M |
64 |
Nomor referensi dari PJP AIS untuk pengembalian dana |
2398509182 04981205970 |
refundAmount |
Object |
|
O |
|
|
|
>value |
String (ISO4217) |
Numeric |
M |
15,2 Note : SNAP BI Length (16,2) |
Jumlah bersih pengembalian dana. Jika itu IDR maka nilainya termasuk 2 angka desimal. misalnya Rp 10.000, akan ditempatkan dengan 10000.00 |
10000.00 |
>currency |
String |
Alpha |
M |
3 |
Mata Uang |
IDR |
refundTime |
String |
Datetime |
M |
25 |
Waktu pengembalian dana. ISO 8601 |
2020-12- 21T17:21:41 +07:00 |
Request & Response Payload Sample
Request :
{ "originalPartnerReferenceNo":"341406425579", "originalReferenceNo":"992922915386", "partnerRefundNo":"341406425579", "refundAmount":{ "value":"1000.00", "currency":"IDR" }, "reason":"testing coba", "additionalInfo":{ "callbackUrl":"https://5fdc5f1948321c00170119e0.mockapi.io/api/v1/simulation/simulation", "settlementAccount":"020601000109305" } }
Normal Response :
{ "responseCode":"2005800", "responseMessage":"Successful", "refundNo":"188908987725", "originalPartnerReferenceNo":"341406425579", "originalReferenceNo":"992922915386", "refundAmount":{ "value":"1000.00", "currency":"IDR" }, "refundTime":"2024-02-16T10:39:19+07:00", "partnerRefundNo":"testing coba" }
Error Response :
{ "responseCode": "4045800", "responseMessage": "Invalid Transaction Status" }
List of Error/Response Code
HTTP Status |
Service Code |
Case Code |
Status |
Response Message |
Deskripsi |
---|---|---|---|---|---|
200 |
58 |
00 |
Sukses |
Successful |
|
400 |
58 |
00 |
Gagal |
Bad Request |
|
400 |
58 |
01 |
Gagal |
Invalid Field Format [field request] |
|
400 |
58 |
02 |
Gagal |
Invalid Mandatory Field [field request] |
|
403 |
58 |
15 |
Gagal |
Transaction Not Permitted [Reason] |
- Transaction Not Permitted. Invalid settlementAccount (settlementAccount bukan rekening BRI / bukan rekening Giro) - Transaction Not Permitted. Failed Process (Transaksi yang dilakukan gagal) |
404 |
58 |
13 |
Gagal |
Invalid Amount |
|
404 |
58 |
18 |
Gagal |
Inconsistent Request |
- Parameter permintaan yang tidak konsisten ditemukan untuk nomor referensi/id transaksi mitra yang sama - partnerReferenceNo & referenceNo melakukan refund setelah sebelumnya sudah fully refund - partnerRefundNo duplicate - amount yang dilakukan refund lebih besar dari amount saat transaksi |
404 |
58 |
00 |
Gagal |
Invalid transaction status |
Status Transaksi Tidak Valid |
404 |
58 |
01 |
Gagal |
Transaction Not Found |
|
409 |
58 |
00 |
Gagal |
Conflict |
|
500 |
58 |
00 |
Gagal |
General Erorr |
|
504 |
58 |
00 |
Pending |
Timeout |
Timeout (Lakukan pengecekan di report H+1) |
Any error response not listed in the BRIAPI response list is considered pending and requires further investigation.
E. Refund Notify
Endpoint ini digunakan untuk memberikan notifikasi dari refund status
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v2.0/debit/notify/refund |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
originalPartnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
202010290000000000056 |
originalReferenceNo |
String |
Numeric |
M |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan. |
2020102900000000000009 |
amount |
Object |
|
O |
|
|
|
>value |
String |
Numeric |
M |
15,2 Note: SNAP BI Length (16,2) |
Jumlah bersih pengembalian dana. Jika itu IDR maka nilainya termasuk 2 angka desimal. misalnya Rp 10.000, akan ditempatkan dengan 10000.00 |
10000000.00 |
>currency |
String (ISO4217) |
Alpha |
M |
3 |
Mata Uang |
IDR |
latestTransactionStatus |
String |
Numeric |
M |
2 |
00 - Success 03 - Pending 06 - Failed |
00 |
transactionStatusDescription |
String |
Alpha |
O |
50 |
Description status transaction |
success |
additionalInfo |
Object |
|
O |
|
|
|
>refundId |
String |
Numeric |
O |
64 |
|
528786398613 |
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Description |
Example |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Respon Kode |
2005600 |
responseMessage |
String |
Alpha |
M |
150 |
Respon Deskripsi |
Successful |
Request & Response Payload Sample
Request :
{ "originalPartnerReferenceNo": "202010290000000000056", "originalReferenceNo": "2020102900000000000009", "amount": { "value": "10000.00", "currency": "IDR" }, "latestTransactionStatus": "00", "transactionStatusDescription": "success", "additionalInfo": { "refundId" : "528786398613" } }
Normal Response :
{ "responseCode": "2005600", "responseMessage": "Successful" }
Error Response :
{ "responseCode": "4045601", "responseMessage": "Transaction Not Found" }
List of Error/Response Code
HTTP Status |
Service Code |
Case Code |
Status |
Response Message |
Description |
---|---|---|---|---|---|
200 |
56 |
00 |
Sukses |
Successful |
|
500 |
56 |
00 |
Gagal |
General Error |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan.