APIDOCS Direct Debit SNAP BI
Informasi API
Judul | API Transfer Debit SNAP BI - API Direct Debit |
---|---|
Versi | v1.0 |
URL Sandbox | https://sandbox.partner.api.bri.co.id |
URL Production |
Version Control
Versi Dok | Versi API | Tanggal | Tautan Dokumen | Deskripsi |
---|---|---|---|---|
v1.0 | v1.0 | 2 Desember 2021 | Halaman ini | Baseline version. |
v2.0 |
v1.0 |
21 April 2022 |
Halaman Ini |
Update field format |
v3.0 |
v1.0 |
26 Oct 2022 |
Halaman Ini |
|
v3.1 |
v1.0 |
01 Des 2022 |
Halaman Ini |
penambahan field settlementAccount di dalam object additionalinfo pada struktur request endpoint Refund Payment |
v3.2 |
v1.0 |
07 Feb 2023 |
Halaman Ini |
Menambahkan catatan bahwa "OTP dan Notif (Binding dan Payment) yang sebelumnya dikirimkan melalui SMS akan dikirimkan melalui Whatsapp" |
Product Description
Catatan: OTP dan Notifikasi (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)
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 |
213423 121521 232 |
|
urlParam |
Object |
|
O |
|
|
|
|
>url |
String |
Alphanumeric |
M |
512 |
The URL |
|
|
>type |
String |
Alpha |
M |
32 |
URL Tipe PAY_RET URN/PAY _NOTIFY |
PAY_N OTIFY |
|
>isDeepLink |
String |
Alpha |
M |
1 |
Apakah URL tersebut adalah deeplink URL atau bukan Y/N |
N |
|
transAmount |
Object |
|
O |
|
|
|
|
>value |
String (ISO421 7) |
Numeric |
M |
15,2 Note : Length SNAP BI (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 |
|
bankCardToken |
String |
|
M Note : SNAP BI (O) |
560 Note : Length SNAP BI (128) |
|
00007100 01 0926 |
|
additionalInfo |
Object |
|
O |
|
Informasi tambahan |
|
|
>otpStatus |
String |
Alpha |
M |
3 |
|
|
|
>settlementAccount |
String |
Numeric |
M |
16 |
|
|
|
>merchentTrxId |
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 |
---|---|---|---|---|---|---|
response Code |
String |
Numeric |
M |
7 |
Respon kode |
|
response Message |
String |
Alpha |
M |
150 |
Respon Deskripsi |
Successful |
reference No |
String |
Numerric |
M Note : SNAP BI (C) |
64 |
Identifikasi transaksi pada sistem layanan konsumen |
20201 02900 00000 0000001 |
partner ReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi pada sistem penyedia layanan. Harus diisisetelah transaksi berhasil |
202010 2977 77000 0000009 |
additional Info |
Object |
|
O |
|
Additional information |
|
>charge Token |
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 |
---|---|---|---|---|---|---|
response Code |
String |
Numeric |
M |
7 |
Respon kode |
2005400 |
response Message |
String |
Alpha |
M |
150 |
Respon deskripsi |
Successful |
partner Reference No
|
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi pada sistem layanan konsumen |
213423121 521232 |
reference No |
String |
Numeric |
M Note : SNAP BI (C) |
64 |
Identifikasi transaksi pada sistem penyedia layanan. Harus diisi setelah transaksi berhasil |
20201 02977 770000 000009 |
additional Info |
String |
|
O |
|
Informasi tambahan |
|
>amount |
String |
Numeric |
M |
15,2 Note : Length SNAP BI (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": "213423121521232", "urlParam": { "url": "http://iniurl.com", "type": "PAY_NOTIFY", "isDeepLink": "N" }, "transAmount": { "value": "", "currency": "" }, "bankCardToken": "xly2uyDFMQ345efsddsf", "additionalInfo": { "otpStatus": "YES", "settlementAccount": "", "merchantTrxId": "", "remarks":"" } }
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": "08493296759260462774", "partnerReferenceNo": "213423121521232", "additionalInfo": { "amount": "2000.00", "currency": "IDR", "merchantTrxId": "", "remarks":"" } }
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 |
|
429 |
54 |
00 |
Gagal |
To Many Request |
|
500 |
54 |
00 |
Gagal |
General Error |
|
504 |
54 |
00 |
Pending |
Timeout |
Timeout (Lakukan pengecekan di 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
Note: Payment status dapat menggunakan "originalPartnerReferenceNo" atau "originalReferenceNo". salah satunya harus diisi walau keduanya optional
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v1.0/debit/status |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
original Partner Reference No |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
2020102900 00000000 0001 |
original ReferenceNo |
String |
Numeric |
O |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan |
2020102977 7700000 00009
|
service Code |
String |
Numeric |
M |
2 |
Indikator jenis transaksi (kode layanan dari permintaan transaksi asli) |
55 |
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
response Code |
String |
Numeric |
M |
7 |
Respon kode |
2005500 |
response Message |
String |
Alpha |
M |
150 |
Respon deskripsi |
Successful |
original Partner ReferenceNo |
String |
Aphanumeric |
O |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
2020102900 00000000 0001 |
original Reference No |
String |
Numeric |
O Note: SNAP BI (C) |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan. harus diisi setelah transaksi berhasil |
20201029777 70000000009
|
service Code |
String |
Numeric |
M |
2 |
Indikator jenis transaksi (kode layanan dari permintaan transaksi asli) |
17 |
latest Transaction Status |
String |
Numeric |
M |
2 |
00 - Success 03 - Pending 06 - Failed |
00 |
transaction StatusDesc |
String |
Alpha |
M Note: SNAP BI (O) |
7 Note : Length SNAP BI |
Deskripsi status transaksi |
success |
original Response Code |
String |
Numeric |
M |
7 |
Respon kode |
2005500 |
refund History |
Array of Object |
|
M |
|
|
|
>partner RefundNo |
String |
Numeric |
M |
64 |
Nomor referensi dari PJP AIS untuk pengembalian dana |
23985 09182 04981 205970 |
>refund Amount |
Object |
|
O |
|
|
|
>>value |
String (ISO4217) |
Numeric |
M |
15,2 Note : Length SNAP BI (16,2) |
Jumlah bersih pengembalian dana |
123456 78.00 |
>>currency |
String |
Alpha |
M |
3 |
Mata Uang |
IDR |
>refund Status |
String |
Numeric |
M |
2 |
00 - Success 06 - Failed |
00 |
>refund Date |
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 : Length SNAP BI (256) |
Alasan pengembalian dana |
Customer complain |
Request & Response Payload Sample
Request :
{ "originalPartnerReferenceNo": "3213123321", "originalReferenceNo": "23132132214193", "serviceCode": "55", }
Normal :
{ "responseCode": "2000000", "responseMessage": "Successfully", "originalPartnerReferenceNo": "2020102900000000000001", "originalReferenceNo": "03644644447113800584999629575440", "latestTransactionStatus": "00", "transactionStatusDesc": "success", "originalResponseCode": "2000000", "serviceCode": "55", "refundHistory": [ { "refundNo": "96194816941239812", "partnerRefundNo": "239850918204981205970", "refundAmount": { "value": "12345678.00", "currency": "IDR" }, "refundStatus": "00", "refundDate": "2020-12-23T07:44:16+07:00", "reason": "Customer Complain" }, { "refundNo": "96194816941239812", "partnerRefundNo": "239850918204981205970", "refundAmount": { "value": "12345678.00", "currency": "IDR" }, "refundStatus": "00", "refundDate": "2020-12-23T07:44:16+07:00", "reason": "Customer Complain" } ] }
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/v1.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 |
202010290 000000000 0001 |
|
originalReferenceNo |
String |
Numeric |
M |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan. |
202010297 777000000 0009 |
|
amount |
Object |
|
O |
|
|
|
|
>value |
String |
Numeric |
M |
15,2 Note : Length SNAP BI (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 (ISO421 7) |
Alpha |
M |
3 |
Mata Uang |
IDR |
|
latestTransactionStatus |
String |
Numeric |
M |
2 |
00 - Success 03 - Pending 06 - Failed |
00 |
|
transactionStatusDesc |
String |
Alpha |
O |
50 |
Deskripsi status transaksi |
success |
|
additionalInfo |
Object |
|
O |
|
|
|
|
>merchantTrxid |
String |
Alphanumeric |
O |
64 |
|
302201075 04 |
|
>refundId |
String |
Numeric |
O |
64 |
|
528786398 613 |
|
>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 |
2000000 |
|
responseMessage |
String |
Alpha |
M |
150 |
Respon deskripsi |
Successful |
|
Request & Response Payload Sample(Payment Notify) :
{ "originalPartnerReferenceNo": "202010290000000000056", "originalReferenceNo": "2020102900000000000009", "amount": { "value": "10000.00", "currency": "IDR" }, "latestTransactionStatus": "00", "transactionStatusDesc": "success", "additionalInfo": { "merchantTrxid": "30220107504", "remarks":"" } }
Normal :
{ "responseCode": "2000000", "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 |
Sukses |
Successful |
|
500 |
56 |
00 |
Gagal |
General Erorr |
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/v1.0/debit/refund |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Acces Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
originalPartnerReferenceNo |
String |
Alphanumeric |
M |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
20201029000 00000000001 |
originalReferenceNo |
String |
Numeric |
M |
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 |
|
M |
|
|
|
>value |
String |
Numeric |
M |
15,2 Note : Length SNAP BI (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 |
Desckripsi |
Contoh |
---|---|---|---|---|---|---|
response Code |
String |
Numeric |
M |
7 |
Respon kode |
2005400 |
response Message |
String |
Alpha |
M |
150 |
Respon deskripsi |
Request has been processed successfully |
originalReferenceNo |
String |
Numeric |
M |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
20201029 77770000 000009 |
originalPartnerReferenceNo |
String |
Alphanumeric |
M Note : SNAP BI (O) |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan. |
20201029 00000000 000001 |
refundNo
|
String |
Numeric |
M |
64 |
Nomor referensi dari PJP AIS untuk pengembalian dana |
239850 9182 049812 05970 |
partnerRefundNo |
String |
Numeric |
M |
64 |
Nomor referensi dari PJP AIS untuk pengembalian dana |
23985 09182 04981 205970 |
refundAmount |
Object |
|
O |
|
|
|
>value |
String (ISO421 7) |
Numeric |
M |
15,2 Note : Length SNAP BI (16,2) |
Jumlah bersih pengembalian dana. Jika itu IDR maka nilainya termasuk 2 angka desimal. misalnya Rp 10.000, akan ditempatkan dengan 10000.00 |
1000 0.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": "2020102900000000000", "originalReferenceNo": "2312312", "partnerRefundNo": "2398509182049812123", "refundAmount": { "value": "10000.00", "currency": "IDR" }, "reason": "Customerx complain", "additionalInfo": { "callbackUrl": "http://(url_partner)/directdebit/notif/refunds", "settlementAccount":"020601000109305" } }
Normal Response:
{ "responseCode": "2000000", "responseMessage": "Request has been processed successfully", "originalPartnerReferenceNo": "2020102900000000000001", "originalReferenceNo": "2020102977770000000009", "refundNo": "202010173821904898012234423", "partnerRefundNo": "", "refundAmount": { "value": "10000.00", "currency": "IDR" }, "refundTime": "2020-12-21T17:07:25+07:00" }
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 settlementAcoount (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 |
400 |
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) |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan
E.Refund Notify
Endpoint ini digunakan untuk memberikan notifikasi dari refund status
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v1.0/debit/notify/refund |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Description |
Example |
---|---|---|---|---|---|---|
originalPartnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi asli pada sistem layanan konsumen |
2020102900 00000000056 |
originalReferenceNo |
String |
Numeric |
M |
64 |
Identifikasi transaksi asli pada sistem penyedia layanan. |
202010290000 0000000009 |
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 |
Deskripsi status transaksi |
success |
additionalInfo |
Object |
|
O |
|
|
|
>refundId |
String |
Numeric |
O |
64 |
|
528786398613 |
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 :
{ "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