APIDOCS Virtual Account/Transfer to VA SNAP BI
API Information
Title |
APIdocs Virtual Account/Transfer to VA |
---|---|
Version |
v1.0 |
URL Sandbox |
|
URL Production |
Version Control
Doc Version |
API Version |
Date |
Link to document |
Description |
---|---|---|---|---|
v1.0 |
v1.0 |
14 Desember 2021 |
this pages |
Baseline version.. |
v2.0 |
v1.0 |
12 May 2022 |
this pages |
Update field format. |
Product Description
Product Overview
The BRI virtual account service feature (BRIVA) to simplify and speed up financial activities which has advantages compared to manual transfers, for example, there is no need to confirm payments manually because they will be verified automatically.
Header Structure
Key |
Value |
Format |
Mandatory |
Length |
Description |
|
---|---|---|---|---|---|---|
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 |
Numeric |
M |
9 |
|
Endpoint
A. Inquiry Payment to VA from Intrabank
Endpoint Description
This endpoint is used to validate virtual accounts
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v1.0/transfer-va/inquiry-intrabank |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Description |
Example |
---|---|---|---|---|---|---|
partnerServiceId |
String |
Numeric |
M |
8 |
Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServi ceId + customerNo or virtualAccountNo |
___88899 |
customerNo |
String |
Numeric |
M |
13 |
Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
1234572 |
virtualAccountNo |
String |
Numeric |
M |
21 |
partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
___87777712345600 |
Response Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Description |
Example |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
response code |
2003200 |
responseMessage |
String |
Alphabet |
M |
150 |
response description |
Successful |
virtualAccountData |
Object |
|
M |
|
||
>partnerServiceId |
String |
Numeric |
M |
8 |
Derivative of X-PARTNER-ID , similar to company code, 8 digit left padding 0. partnerServiceId + customerNo or virtualAccountNo |
___77777 |
>customerNo |
String |
Numeric |
M |
13 |
Unique number up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
12345600 |
>virtualAccountNo |
String |
Numeric |
M |
21 |
partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits).partnerServiceId + customerNo or virtualAccountNo |
___7777712345600 |
>virtualAccountName |
String |
Alphanumeric |
M Notes : SNAP BI (O) |
250 |
Customer Name |
Jokul Doe |
>TotalAmount |
Object |
O |
|
|||
>>value |
String |
Numeric |
O |
15,2 |
Transaction Amount. Transaction Amount. |
10000000000.00 |
>>currency |
String |
Numeric |
O |
3 |
Currency |
IDR |
>additionalInfo |
|
|
O |
|
||
>>description |
String |
Alphanumeric |
O |
40 |
as a remark , additional description for create Briva |
Keterangan |
Request & Response Payload Sample
Request
{ "partnerServiceId": " 77777", "customerNo": "12345600", "virtualAccountNo": " 7777712345600" }
Normal Response :
{ "responseCode": "2003200", "responseMessage": "Successful", "virtualAccountData": { "partnerServiceId": " 77777", "customerNo": "12345600", "virtualAccountNo": " 7777712345600", "virtualAccountName": "Jokul Doe", "totalAmount": { "value": "100000000000000.00", "currency": "IDR" }, "additionalInfo": { "description": "keterangan" } } }
Error Response :
{ "responseCode": "5043200", "responseMessage": "Timeout" }
List of Error/Response Code
HTTP Status |
Service Code |
Case Code |
Status |
Response Description |
Description |
---|---|---|---|---|---|
200 |
32 |
00 |
Success |
Successful |
|
400 |
32 |
00 |
Failed |
Bad Request |
|
400 |
32 |
01 |
Failed |
Invalid Field Format |
|
400 |
32 |
02 |
Failed |
Invalid Mandatory Field |
|
404 |
32 |
12 |
Failed |
Invalid Bill/Virtual Account |
|
404 |
32 |
14 |
Failed |
Paid Bill |
|
404 |
32 |
19 |
Failed |
Expired Bill |
|
409 |
32 |
00 |
Failed |
Conflict |
|
504 |
32 |
00 |
Failed |
Timeout |
Any error response not listed in the BRIAPI response list is considered pending and requires further investigation.
B. Payment To VA Intrabank
Endpoint Description
This endpoint is used to make a transfer to a virtual account
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v1.0/transfer-va/payment-intrabank |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Description |
Example |
---|---|---|---|---|---|---|
partnerServiceId |
String |
Numeric |
M |
8 |
Derivative of X- PARTNER- ID , similar to company code. partnerServiceId + customerNo or virtualAccountNo |
___77777 |
customerNo |
String |
Numeric |
M |
13 |
18138200 Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
18138200 |
virtualAccountNo |
String |
Numeric |
M |
21 |
partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
__7777718138200 |
virtualAccountName |
String |
Alphanumeric |
O |
250 |
Customer Name |
Jokul Doe |
sourceAccountNo |
String |
Numeric |
M Notes : SNAP BI (O) |
15 |
Source account number |
001901000032531 |
partnerReferenceNumber |
String |
Numeric |
M |
28 |
Unique identifier for this Payment. Generated by Partner. |
2261110855 |
paidAmount |
Object |
|
M |
|
||
>value |
String |
Numeric |
M |
15,2 |
Transaction Amount. Transaction Amount. |
10001.00 |
>currency |
String |
Alphabet |
M |
3 |
Currency |
IDR |
trxDateTime |
Date |
Numeric |
M Notes : SNAP BI (O) |
25 |
PJP internal system datetime with timezone, which follows the ISO-8601 standard |
2022-01-21T08:30:25+07:00 |
Response Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Description |
Example |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
response code |
2003300 |
responseMessage |
String |
Alphabet |
M |
150 |
response description |
Successful |
virtualAccountData |
Object |
|
M |
|
||
>partnerServiceId |
String |
Numeric |
M |
8 |
Derivative of X-PARTNER-ID , similar to company code, 8 digit left padding 0. partnerServiceId + customerNo or virtualAccountNo |
___77777 |
>customerNo |
String |
Numeric |
M |
13 |
Unique number up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
18138200 |
>virtualAccountNo |
String |
Numeric |
M |
21 |
partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
__7777718138200 |
>virtualAccountName |
String |
Alphanumeric |
M |
250 |
Customer Name |
Jokul Doe |
>paidAmount |
Object |
|
O |
|
||
>>value |
String |
Numeric |
M |
15,2 |
Transaction Amount. From Payment Request. |
1000.00 |
>>currency |
String |
Alphabet |
M |
3 |
From Payment Request |
IDR |
trxDateTime |
Date |
Numeric |
O |
25 |
PJP internal system datetime with timezone, which follows the ISO-8601 standard |
2022-01-21T08:30:25+07:00 |
Request & Response Payload Sample
Request
{ "partnerServiceId": "77777", "customerNo": "18138200", "virtualAccountNo": " 7777718138200", "virtualAccountName": "Jokul Doe", "sourceAccountNo": "001901000032531", "partnerReferenceNumber": "2261110855", "trxDateTime": "2022-01-21T08:30:25+07:00", "paidAmount": { "value": "10000.00", "currency": "IDR" } }
Normal Response :
{ "responseCode": "2003300", "responseMessage": "Successful", "virtualAccountData": { "partnerServiceId": " 77777", "customerNo": "18138200", "virtualAccountNo": " 7777718138200", "virtualAccountName": "Jokul Doe", "paymentRequestId": "22755021525", "partnerReferenceNumber": "2261110855", "trxDateTime": "2022-01-21T08:30:25+07.00", "paidAmount": { "value": "10000.00", "currency": "IDR" } } }
Error Response :
{ "responseCode": "4003301", "responseMessage": "Invalid Field Format virtualAccountNo" }
List of Error/Response Code
HTTP Status |
Service Code |
Case Code |
Status |
Response Description |
Description |
---|---|---|---|---|---|
200 |
33 |
00 |
Success |
Success |
|
400 |
33 |
00 |
Failed |
Bad Request |
|
400 |
33 |
01 |
Failed |
Invalid Field Format |
|
400 |
33 |
02 |
Failed |
Invalid Mandatory Field |
|
403 |
33 |
02 |
Failed |
Exceeds Transaction Amount Limit |
|
403 |
33 |
09 |
Failed |
Dormant Account |
|
403 |
33 |
14 |
Failed |
Insufficient Funds |
|
403 |
33 |
15 |
Failed |
Transaction Not Permitted |
|
403 |
33 |
16 |
Pending |
Suspend Transaction |
|
403 |
33 |
18 |
Failed |
Inactive Card/Account/Customer |
|
404 |
33 |
11 |
Failed |
Invalid Card/Account/Customer [info]/Virtual Account |
|
404 |
33 |
12 |
Failed |
Invalid Bill/Virtual Account |
|
404 |
33 |
13 |
Failed |
Invalid Amount |
|
404 |
33 |
14 |
Failed |
Paid Bill |
|
404 |
33 |
19 |
Failed |
Expired Bill |
|
409 |
33 |
00 |
Failed |
Conflict |
|
500 |
33 |
00 |
Pending |
General Error |
|
504 |
33 |
00 |
Pending |
Timeout |
Any error response not listed in the BRIAPI response list is considered pending and requires further investigation.