Dokumentasi Virtual Account/Notification for Payment (Push Notif)

API Information

Title	APIdocs Virtual Account/Notification for Payment (Push Notif)
Version	v1.0
URL Sandbox	https://sandbox.partner.api.bri.co.id
URL Production

Version Control

Example:

Doc Version	API Version	Date	Link to document	Description
v1.0	v1.0	14 Desember 2021	this pages	Baseline version.
v2.0	v1.0	26 Apr 2022	this pages	Update field format
v3.0	v1.0	29 Jan 2024	this pages	Update field virtualAccountData in Response Structure
v3.1	v1.0	24 Mar 2024	this pages	Update field idApp & passApp from M (Mandatory) to O (Optional)

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		Alphanumeric	M	12

Endpoint

Notification Payment to VA Intrabank

Endpoint Description

This Endpoint is used to flagging notification for payment status to VA from intrabank

General Information

HTTP Method	POST
Path	Snap/v1.0/transfer-va/notify-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 Notes : SNAP BI length (20)	nique number (up to 20 digits). 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	___7777708577508881
trxDateTime	Date	Numeric	M Notes: SNAP BI (O)	25	PJP internal system datetime with timezone, which follows the ISO-8601 standard	2023-12-04T08:34:00+07:00
paymentRequestId	String	Numeric	M Notes : SNAP BI (O)	30 Notes : SNAP BI length (128)	transaksiID generated from PJP, unique ID for each transaction	2027912345671234567
additionalInfo	Object		O
>idApp	String	Alphanumeric	O	8	Bank identifier from 3rd parties	24123244
>passApp	String	Alphanumeric	O	64	Key from 3rd parties to access API	354324134
>paymentAmount	String	Numeric	M	10	Amount of payment	650000
>terminalId	String	Numeric	O	1	Channel ID 1 : Teller 2 : ATM 3 : IB 4 : SMSB 5 : CMS 6 : EDC 7 : RTGS 8 : OTHER 9 : API	1
>bankId	String	Numeric	O	3	Bank ID (‘002’ for BRI)	002

Response Structure

Field	Data Type	Format	Mandatory	Length	Description	Example
responseCode	String	Numeric	M	7	response code	2003400
responseMessage	String	Alphabet	M	150	response description	Successful
virtualAccountData	Object		O
>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 Notes : SNAP BI length (20)	Unique number up to 20 digits). 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	___77777342353423
>inquiryRequestId	String	Alphanumeric	O	128	from inquiry request	abcdef-123456-abcdef
>paymentRequestId	String	Numeric	M Notes : SNAP BI (0)	30 Notes : SNAP BI length (128)	transaksiID generated from PJP, unique ID for each transaction	2027912345671234567
>trxDateTime	Date	Numeric	O	25	PJP internal system datetime with timezone, which follows the ISO-8601 standard	2023-12-04T08:34:00+07:00
>paymentStatus	String	Alphabet	O	20	Status of payment request	Success

Request & Response Payload Sample

Request :

{
"partnerServiceId": "___77777",
"customerNo": "08577508881",
"virtualAccountNo": "___77777085775088813",
"paymentRequestId": "24123244",
"trxDateTime": "2023-12-04T08:34:00+07:00",
"additionalInfo": {
    "idApp": "24123244",
    "passApp": "354324134",
    "paymentAmount": "650000",
    "terminalId" : "1",
    "bankId": "002",
    }
}

Normal Response:

{
"responseCode": "2003400",
"responseMessage": "Successful",
"virtualAccountData": {
    "partnerServiceId": "___77777",
    "customerNo": "342353423",
    "virtualAccountNo": "___77777342353423",
    "paymentRequestId": "24123244",
    "trxDateTime": "2023-12-04T08:34:00+07:00",
    "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
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

Any error response not listed in the BRIAPI response list is considered pending and requires further investigation.

Virtual Account/Notification for Payment (Push Notif)