Virtual Account/Notification for Payment
Informasi API
|
Title |
APIdocs Virtual Account/Notification for Payment (Push Notif) |
|---|---|
|
Version |
v1.0 |
|
URL Sandbox |
|
|
URL Production |
Kendali Versi
Example:
|
Versi API |
Tanggal |
Tautan Dokumen |
Deskripsi |
|---|---|---|---|
|
v1.0 |
14 Desember 2021 |
Halaman Ini |
Baseline version. |
|
v2.0 |
26 Apr 2022 |
Halaman ini |
Update field format |
Product Description
Gambaran Produk
Fitur layanan virtual account BRI (BRIVA) untuk mempermudah dan mempercepat aktivitas keuangan yang memiliki keunggulan dibandingkan transfer manual, misalnya tidak perlu melakukan konfirmasi pembayaran secara manual karena akan terverifikasi secara otomatis.
Header Structure
|
Key |
Value |
Format |
Mandatory |
Length |
Deskripsi |
|---|---|---|---|---|---|
|
Authorization |
Authorization |
|
M |
|
Bearer {Token} |
|
X-TIMESTAMP |
BRI - Timestamp |
|
M |
|
|
|
X-SIGNATURE |
BRI - Signature |
|
M |
|
HMAC_SHA512 |
|
Content-type |
application/json |
|
M |
|
application/json |
|
X-PARTNER-ID |
|
Alphanumeric |
M |
36 |
|
|
CHANNEL-ID |
|
Numeric |
M |
5 |
|
|
X-EXTERNAL-ID |
|
Alphanumeric |
M |
12 |
|
Endpoint
Notification Payment to VA Intrabank
Endpoint Description
Endpoint ini digunakan untuk melaporkan notifikasi status pembayaran ke VA dari intrabank
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 |
|---|---|---|---|---|---|---|
|
partnerServiceId |
String |
Numeric |
M |
8 |
Turunan X-PARTNER-ID, mirip dengan kode perusahaan. partnerServiceId + customerNo or virtualAccountNo |
77777 |
|
customerNo |
String |
Numeric |
M |
13 Notes : SNAP BI length
(20) |
Nomor unik (hingga 20 digit) partnerServiceId + customerNo or virtualAccountNo |
08577508881 |
|
virtualAccountNo |
String |
Numeric |
M |
28 |
partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
77777085 77508881 |
|
partnerReferenc eNumber |
String |
Numeric |
M |
28 |
Pengenal unik untuk Pembayaran ini. Dihasilkan oleh Mitra. |
24123244 |
|
trxDateTime |
Date |
Numeric |
M |
25 |
Tanggal waktu sistem internal PJP dengan zona waktu, yang mengikuti standar ISO-8601 |
20201231T23 5959Z |
|
inquiryRequestId |
String |
Alphanum eric |
O |
128 |
dari inquiry request |
abcdef-123456- abcdef |
|
additionalInfo |
Object |
|
O |
|
|
|
|
>idApp |
String |
Alphanum eric |
M |
8 |
Bank identifier dari pihak ketiga |
24123244 |
|
>passApp |
String |
Alphanum eric |
M |
64 |
Kunci dari pihak ketiga untuk mengakses API |
354324134 |
|
>paymentAmou nt |
String |
Numeric |
M |
10 |
Jumlah pembayaran |
650000 |
Response Structure
|
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
|---|---|---|---|---|---|---|
|
responseCode |
String |
Numeric |
M |
7 |
response code |
2003400 |
|
responseMessage |
String |
Alphabet |
M |
150 |
response description |
Successful |
|
virtualAccountDa ta |
Object |
|
M |
|
|
|
|
>partnerServiceId |
String |
Numeric |
M |
8 |
Turunan X-PARTNER-ID, mirip dengan kode perusahaan, 8 digit left padding 0. partnerServiceId + customerNo or virtualAccountNo |
77777 |
|
>customerNo |
String |
Numeric |
M |
13 Notes : SNAP BI length
(20) |
Nomor unik (hingga 20 digit). partnerServiceId + customerNo or virtualAccountNo |
342353423 |
|
>virtualAccountNo |
String |
Numeric |
M |
28 |
partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
7777734 2353423 |
|
>inquiryRequestId |
String |
Alphanum eric |
O |
128 |
dari inquiry request |
abcdef-123456- abcdef |
|
>partnerReferen ceNumber |
String |
Numeric |
M |
28 |
Pengenal unik untuk Pembayaran. Dibuat oleh Mitra |
24123244 |
|
>trxDateTime |
Date |
Numeric |
M |
25 |
Tanggal waktu sistem internal PJP dengan zona waktu, yang mengikuti standar ISO-8601 |
20201231T2 35959Z |
|
>paymentStatus |
String |
Alphanum eric |
O |
20 |
Status permintaan pembayaran |
Success |
Request & Response Payload Sample
Request :
{
"partnerServiceId": "___77777",
"customerNo": "08577508881",
"virtualAccountNo": "___77777085775088813",
"partnerReferenceNumber": "24123244",
"trxDateTime": "20201231T235959Z",
"additionalInfo": {
"idApp": "24123244",
"passApp": "354324134",
"paymentAmount": "650000"
},
"inquiryRequestId": "abcdef-123456-abcdef"
}
Normal Response:
{
"responseCode": "2003400",
"responseMessage": "Successful",
"virtualAccountData": {
"partnerServiceId": "___77777",
"customerNo": "342353423",
"virtualAccountNo": "___77777342353423",
"inquiryRequestId": "abcdef-123456-abcdef",
"partnerReferenceNumber": "24123244",
"trxDateTime": "20201231T235959Z",
"paymentStatus": "Success",
}
}
Error Response :
{
"responseCode": "4013401",
"responseMessage": "Unauthorized. Verify Client Secret Fail."
}
List of Error/Response Code
|
HTTP Status |
Service Code |
Case Code |
Status |
Response Description |
Deskripsi |
|
200 |
34 |
00 |
Success |
Successful |
|
|
400 |
34 |
00 |
Failed |
Bad Request |
|
|
400 |
34 |
01 |
Failed |
Invalid Field Format |
|
|
400 |
34 |
02 |
Failed |
Invalid Mandatory Field |
|
|
401 |
34 |
00 |
Failed |
Unauthorized. Verify Client Secret Fail |
|
|
404 |
34 |
16 |
Failed |
Partner Not Found |
|
|
500 |
34 |
00 |
Pending |
General Error |
|
|
500 |
34 |
02 |
Pending |
Unknown Error |
|
|
504 |
34 |
00 |
Pending |
Timeout |