Dokumentasi APIDOCS Virtual Account/Briva WS SNAP BI

API Information

Title	API Virtual Account/Briva WS
Version	v1.0
URL Sandbox	`https://sandbox.partner.api.bri.co.id`
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	22 April 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		Format Timestamp ISO8601
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	9

Endpoint

A. Create VA

Endpoint Description

This endpoint is used to create a new BRI virtual account

General Information

HTTP Method	POST
Path	snap/v1.0/transfer-va/create-va
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. partnerServiceId + customerNo or virtualAccontNo	___77777
customerNo	String	Numeric	M	13 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	28138102
virtualAccountNo	String	Numeric	M	28	partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo (kalau devportal BI partnerServiceId + customerNo)	___7777728138 102
totalAmount	Object		M Note : SNAP BI (O)
>value	String	Numeric	M	15,2 Note: SNAP BI length (16,2)	Transaction Amount. Total Amount with 2 decimal	10000.00
>currency	String	Alphabet	M	3	Currency of amount based on ISO 4217	IDR
virtualAccountName	String	Alphanumeric	M	40 Note: SNAP BI length (255)	Customer Name	John Doe
expiredDate	String	NumericDate	M Note : SNAP BI (O)	25	Transaction Amount. Total Amount with 2 decima	2022-02-28T22: 38:25+07:00
trxId	String	Alphanumeric	M	64	Transaction ID in Partner system	abcdefgh1234
additionalInfo	String		M Note : SNAP BI (O)		Additional Information for custom use
>description	String	Alphanumeric	M	40	as a remark , additional description for create Briva	keterangan

Response Structure

Field	Data Type	Format	Mandatory	Length	Description	Example
responseCode	String	Numeric	M	7	Respon Code	2002700
responseMessage	String	Alphabet	M	150	Respon Description	Successful
virtualAccountData	Object		M
>partnerServiceId	String	Numeric	M	8	Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccontNo	___77777
>customerNo	String	Numeric	M	13 Note: SNAP BI length 20	Unique number (up to 20 digits). partnerServi ceId + customerNo or virtualAccountNo	28138102
>virtualAccountNo	String	Numeric	M	28	partnerServi ceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	___7777728138 102
>virtualAccountName	String	Alphanumeric	M	40 Note: SNAP BI length (255)	Customer name	John Doe
>trxId	String		M	32	from Create VA Request	abcdefgh1234
>totalAmount	Object	Alphabet	M Note: SNAP BI (O)
>>value	String	Numeric	M	15,2 Note: SNAP BI length (16,2)	Transaction Amount. Total Amount with 2 decimal.	10000.00
>>currency	String		M	3	Currency. Currency of amount based on ISO 4217.	IDR
>expiredDate	String	NumericDate	M Note: SNAP BI (O)	25		2022-02-28T22: 38:25+07:00
>additionalInfo	Object		M		Additional Information for custom use
>>description	String	Alphanumeric	M	40	Additional description for create Briva	keterangan

Request & Response Payload Sample

Request :

        {
            "partnerServiceId": "   77777",
            "customerNo": "28138102",
            "virtualAccountNo": "   7777728138102",
            "virtualAccountName": "Jokul",
            "totalAmount": {
                "value": "10000.00",
                "currency": "IDR"
            },
            "expiredDate": "2022-02-28T22:38:25+07:00",
            "trxId": "abcdefgh1234",
            "additionalInfo": {
                "description": "keterangan"
            }
        }		}

Normal Response :

        {
            "responseCode": "2002700",
            "responseMessage": "Successful",
            "virtualAccountData": {
                "partnerServiceId": "   77777",
                "customerNo": "28138102",
                "virtualAccountNo": "   7777728138102",
                "virtualAccountName": "John Doe ",
                "trxId": "abcdefgh1234",
                "totalAmount": {
                    "value": "10000.00",
                    "currency": "IDR"
                },
                "expiredDate": "2022-02-28T22:38:25+07:00",
                "additionalInfo": {
                    "description": "keterangan"
                }
            }
        }

Error Response :

          {
            "responseCode": "4002702",
            "responseMessage": "Invalid Mandatory Field partnerServiceId"
          }

List of Error/Response Code

HTTP Status	Service Code	Case Code	Status	Response Description
200	27	00	Success	Successful
400	27	00	Failed	Bad Request
400	27	01	Failed	Invalid Field Format
400	27	02	Failed	Invalid Mandatory Field
401	27	00	Failed	Unauthorized. Client Forbidden Access API
404	27	12	Failed	Invalid Bill/Virtual Account. [Reason]
404	27	13	Failed	Invalid Amount
404	27	16	Failed	Partner Not Found
409	27	01	Failed	Conflict
500	27	00	Pending	General Error
504	27	00	Pending	Timeout

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

B. Update VA

Endpoint Description

This Endpoint is used to used to update existing BRIVA account details

General Information

HTTP Method	POST
Path	/snap/v1/transfer-va
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 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	181381003
virtualAccountNo	String	Numeric	M	28	partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	___7777718138 1003
virtualAccountName	String	Alphanumeric	M	40 Note: SNAP BI length (255)	Customer Name	John Doe
totalAmount	Object		M Note: SNAP BI (O)
value	String	Numeric	M	15,2 Note: SNAP BI length (16,2)	Transaction Amount. Total Amount with 2 decimal. (ISO4217)	1000.00
currency	String	Alphabet	M	3	Currency. Currency of amount based on ISO 4217.	IDR
trxId	String	Alphanumeric	M	64	Transaction ID in Partner system	abcdefgh1234
expiredDate	String	NumericDate	M Note : SNAP BI (O)	25	Expiration date for Virtual Account. ISO-8601	022-02-28T22: 38:25+07:00
additionalInfo	String		M Note : SNAP BI (O)		Additional Information for custom use
>description	String	Alphanumeric	M	40	Additional description for create Briva	keterangan

Response Structure

Field	Data Type	Format	Mandatory	Length	Description	Example
responseMessage	String	Alphabet	M	150	Response Description	Successful
responseCode	String	Numeric	M	7	responseCode	2002800
virtualAccountData	Object		M
>partnerServiceId	String	Numeric	M	8	Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo	___77777
>customerNo	String	Numeric	M	13 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServi ceId + customerNo or virtualAccountNo	181381003
>virtualAccountNo	String	Numeric	M	28	partnerServi ceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServi ceId + customerNo or virtualAccou ntNo	___7777718138 1003
>virtualAccountName	String	Alphanumeric	M	40 Note: SNAP BI length (255)	Customer name	John Doe
>trxId	String	Alphanumeric	M	32	Transaction ID in Partner system	abcdefgh1234
>totalAmount	Object		M Note : SNAP BI (O)
>>value	String	Numeric	M	15,2 Note: SNAP BI length (16,2)	Transaction Amount. Bill Amount with 2 decimal. (ISO4217)	1000.00
>>currency	String	Alphabet	M	3	Currency. Currency of amount based on ISO 4217.	IDR
>expiredDate	String	Numeric	M Note : SNAP BI (O)	25	Expiration date for Virtual Account. ISO-8601	2022-02-28T22: 38:25+07:00
>additionalInfo	Object		M Note : SNAP BI (O)
>>description	String	Alphanumeric	M	40	Additional description for create Briva	keterangan

Request & Response Payload Sample

Request:

{
    "partnerServiceId": "   77777",
    "customerNo": "181381003",
    "virtualAccountNo": "   77777181381003",
    "virtualAccountName": "John Doe",
    "totalAmount": {
        "value": "1000.00",
        "currency": "IDR"
    },
    "expiredDate": "2022-02-28T22:38:25+07:00",
    "trxId": "abcdefgh1234",
    "additionalInfo": {
        "description": "keterangan"
    }
}

Normal Response :

 {
    "responseCode": "2002800",
    "responseMessage": "Successful",
    "virtualAccountData": {
        "partnerServiceId": "   77777",
        "customerNo": "181381003",
        "virtualAccountNo": "   77777181381003",
        "virtualAccountName": "John Doe",
        "trxId": "abcdefgh1234",
        "totalAmount": {
            "value": "1000.00",
            "currency": "IDR"
        },
        "expiredDate": "2022-02-28T22:38:25Z",
        "additionalInfo": {
            "description": "keterangan"
        }
    }
}

Error Response :

{
    "responseCode": "4002802",
    "responseMessage": "Invalid Mandatory Field partnerServiceId"
}

List of Error/Response Code

HTTP Status	Service Code	Case Code	Status	Response Description
200	28	00	Success	Successful
400	28	00	Failed	Bad Request
400	28	01	Failed	Invalid Field Format
400	28	02	Failed	Invalid Mandatory Field
401	28	00	Failed	Unauthorized. Client Forbidden Access API
404	28	12	Failed	Invalid Bill/Virtual Account. [Reason]
404	28	13	Failed	Invalid Amount
404	28	16	Failed	Partner Not Found
409	28	01	Failed	Conflict
500	28	00	Pending	General Error
504	28	00	Pending	Timeout

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

C. Update Status VA

Endpoint Description

This Endpoint is used to manage payment status of existing BRIVA accounts

General Information

HTTP Method	POST
Path	snap/v1/transfer-va/update-status
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 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServi ceId + customerNo or virtualAccountNo	08138598
virtualAccountNo	String	Numeric	M	28	28 partnerServi ceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServi ceId + customerNo or virtualAccou ntNo	___7777708 138598
trxId	String	Alphanumeric	M	64	Transaction ID in Partner system	abcdefgh12 34
paidStatus	String	Alphabet	M	1	Y = Paid N = Not Paid	Y

Response Structure

Field	Data Type	Mandatory	Length	Description	Example
responseMessage	String	Alphabet	M	150	ResponseCode	2002900
responseCode	String	Numeric	M	7	ResponseCode	Successful
virtualAccountData	Object		M
>partnerServiceId	String	Numeric	M	8	Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo	___77777
>customerNo	String	Numeric	M	13 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	08138598
>virtualAccountNo	String	Numeric	M	28	partnerServiceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	___777770 8138598
>trxId	String	Alphanumeric	M	64	Transaction ID in Partner system	abcdefgh12 34
>additionalInfo	Object		O		additional info
>>paidStatus	Alphabet	Alphabet	M	1	paid status transaction	Y

Request & Response Payload Sample

Request :

{
    "partnerServiceId": "   77777",
    "customerNo": "08138598",
    "virtualAccountNo": "   7777708138599",
    "trxId": "abcdefgh1234",
    "paidStatus": "Y"
}

Normal Response :

 {
    "responseCode": "2002900",
    "responseMessage": "Successful",
    "virtualAccountData": {
        "partnerServiceId": "   77777",
        "customerNo": "08138598",
        "virtualAccountNo": "   7777708138598",
        "trxId": "abcdefgh1234",
        "additionalInfo": {

             "paidStatus": "Y"        

        },
        
    }
}

Error Response :

{
    "responseCode": "4042912",
    "responseMessage": "Invalid Bill/Virtual Account"
}

List of Error/Response Code

HTTP Status	Service Code	Case Code	Status	Response Description
200	29	00	Success	Successful
400	29	00	Failed	Bad Request
400	29	01	Failed	Invalid Field Format
400	29	02	Failed	Invalid Mandatory Field
401	29	00	Failed	Unauthorized. Client Forbidden Access API
404	29	12	Failed	Invalid Bill/Virtual Account. [Reason]
404	29	13	Failed	Invalid Amount
404	29	16	Failed	Partner Not Found
409	29	01	Failed	Conflict
500	29	00	Pending	General Error
504	29	00	Pending	Timeout

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

D. Inquiry VA

Endpoint Description

This Endpoint is used to get virtual account information that has been created

General Information

HTTP Method	POST
Path	snap/v1/transfer-va/inquiry-va
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 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	08138594
virtualAccountNo	String	Numeric	M	28	28 partnerServi ceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	___7777708 138594
trxId	String	Alphanumeric	M	64	Transaction ID in Partner system	abcdefgh12 34

Response Structure

Field	Data Type	Format	Mandatory	Length	Description	Example
responseCode	String	Numeric	M	7	Response Code	Successful
responseMessage	String	Alphabet	M	150	Response Code	2002900
virtualAccountData	Object		M
>partnerServiceId	String	Numeric	M	8	Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServi ceId + customerNo or virtualAccountNo	___77777
>customerNo	String	Numeric	M	13 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServi ceId + customerNo or virtualAccountNo	08138598
>virtualAccountNo	String	Numeric	M	28	partnerServi ceId (8 digit left padding space) + customerNo (up to 20 digits). partnerServi ceId + customerNo or virtualAccou ntNo	___777770813 8594
>trxId	String	Alphanumeric	M	32	Transaction ID in Partner system	abcdefgh12 34
>totalAmount	String		M Note : SNAP BI (O)
>>value	String	Numeric	M	15,2 Note: SNAP BI length (16,2)	Bill Amount with 2 decimal (ISO 4217)	1000000000000.00
>>currency	String	Alphabet	M	3	Currency of amount based on ISO 4217.	IDR
>expiredDate	String	NumericDate	M Note : SNAP BI (O)	25	Expiration date for Virtual Account. ISO-8601	2022-02-28T22: 38:25+07:00
>additionalInfo	String		M Note : SNAP BI (O)		Additional Information for custom use
>description	String	Alphanumeric	M	40	Additional description for create Briva	Keterangan

Request & Response Payload Sample

Request :

{
    "partnerServiceId":"77777",
    "customerNo":"08138594",
    "virtualAccountNo":"7777708138599",
    "trxId":"abcdefgh1234"
}

Normal Response :

 {
    "responseCode": "2003000",
    "responseMessage": "Successful",
    "virtualAccountData": {
        "partnerServiceId": "   77777",
        "customerNo": "08138594",
        "virtualAccountNo": "   7777708138594",
        "virtualAccountName": "John Doe",
        "trxId": "abcdefgh1234",
        "totalAmount": {
            "value": "1000000000000.00",
            "currency": "IDR"
        },
        "expiredDate": "2022-02-28T22:38:25Z",
        "additionalInfo": {
            "description": "keterangan"
        }
    }
}

Error Response :

{
    "responseCode": "4043012",
    "responseMessage": "Invalid Bill/Virtual Account"
}

List of Error/Response Code

HTTP Status	Service Code	Case Code	Status	Response Description
200	30	00	Success	Successful
400	30	00	Failed	Bad Request
400	30	01	Failed	Invalid Field Format
400	30	02	Failed	Invalid Mandatory Field
401	30	00	Failed	Unauthorized. Client Forbidden Access API
404	30	12	Failed	Invalid Bill/Virtual Account. [Reason]
404	30	13	Failed	Invalid Amount
404	30	16	Failed	Partner Not Found
409	30	01	Failed	Conflict
500	30	00	Pending	General Error
504	30	00	Pending	Timeout

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

E. Delete VA

Endpoint Description

This Endpoint is used to delete existing BRIVA data

General Information

HTTP Method	POST
Path	snap/v1/transfer-va/delete-va
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 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	08138594
virtualAccountNo	String	Numeric	M	28	partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	___7777708 138594
trxId	String	Alphanumeric	M Note : SNAP BI (O)	64	Transaction ID in Partner system	abcdefgh1234

Response Structure

Field	Data Type	Format	Mandatory	Length	Description	Example
responseCode	String	Numeric	M	7	Response Code	2003100
responseMessage	String	Alphabet	M	150	Response Description	Successful
virtualAccountData	Json/Object		M
>partnerServiceId	String	Numeric	M	8	Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo	___77777
>customerNo	String	Numeric	M	13 Note: SNAP BI length (20)	Derivative of X- PARTNER- ID , similar to company code. partnerServiceId + customerNo or virtualAccountNo	08138594
>virtualAccountNo	String	Numeric	M	28	28 partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServi ceId + customerNo or virtualAccountNo	___777770 8138594
> trxId	String	Alphanumeric	O Note : SNAP BI (O)	64	Transaction ID in Partner system	abcdefgh12 34
additionalInfo	Object		O Note : SNAP BI (O)		Additional information for custom use
description	String	Alphanumeric	M	40	Additional description for create Briva	keterangan

Request & Response Payload Sample

Request :

{
    "partnerServiceId": "   77777",
    "customerNo": "08138594",
    "virtualAccountNo": "   7777708138599000000999099",
    "trxId": "abcdefgh1234"
}

Normal Response :

{

    "responseCode": "2003100",

    "responseMessage": "Successful",

    "virtualAccountData": {

        "partnerServiceId": "   77777",

        "customerNo": "08138594",

        "virtualAccountNo": "   7777708138594"

    }

}

Error Response :

{
    "responseCode": "4003102",
    "responseMessage": "Invalid Mandatory Field partnerServiceId"
}

List of Error/Response Code

HTTP Status	Service Code	Case Code	Status	Response Description
200	31	00	Success	Successful
400	31	00	Failed	Bad Request
400	31	01	Failed	Invalid Field Format
400	31	02	Failed	Invalid Mandatory Field
401	31	00	Failed	Unauthorized. Client Forbidden Access API
404	31	12	Failed	Invalid Bill/Virtual Account. [Reason]
404	31	13	Failed	Invalid Amount
404	31	16	Failed	Partner Not Found
409	31	01	Failed	Conflict
500	31	00	Pending	General Error
504	31	00	Pending	Timeout

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

F. Get Report

Endpoint Description

This Endpoint is used to get the transaction history of all BRIVA accounts registered on the user's BRIVA number

Endpoint Description

This Endpoint is used to get the transaction history of all BRIVA accounts registered on the user's BRIVA number

Note :
-get report not yet 24 hours
- there is a time reduction of 10 minutes and 5 minutes from the payment delay

General Information

HTTP Method	POST
Path	snap/v1.0/transfer-va/report
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	From Payment Request. Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo	___88899
startDate	String	NumericDate	M Note : SNAP BI (O)	10	Start Date for Report yyyy-MM-dd	2021-12-06
startTime	String	NumericDate	M Note : SNAP BI (O)	14	Start Time for Report. HH:mm If used, must send startDate If startDate exists without startTime, default startTime = 00:00 Note : BRI only filter this field up to minutes	14:56:00+07:00
endTime	String	NumericDate	M Note : SNAP BI (O)	5	End Time for Report. HH:mm If used, must send endDate. If endDate exists Note: BRI only filter this field up to minutes	23:59
additionalInfo	Object	Object	O
>customerCode	String	Numeric	O	13	Max 13 digit code customer BRIVA	0812345679
>uniqueCode	String	String	O	10	BRIVA unique code if the value of partnerServiceId that registered is BRIVA corporate

Response Structure

Field	Data Type	Format	Mandatory	Length	Description	Example
responseCode	String	Numeric	M	7	Response Code	2003500
responseMessage	String	Alphabet	M	150	Response Description	Successful
virtualAccoutData	Array of Object		M
>partnerServiceId	String	Numeric	M	8	Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo	___88899
>customerNo	String	Numeric	M	20	Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	1234557 767792
>virtualAccountNo	String	Numeric	M	28	partnerServi ceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	___8889912345 57767792
>virtualAccountName	String	Alphanumeric	M	255	Customer name	John Doe
>trxId	String	Alphanumeric	M	64	Transaction ID	2130780041019445767
>totalAmount	Object		M
>>value	String	Numeric	M	15,2 Note: SNAP BI length (16,2)	Bill Amount with 2 decimal	10.00
>>currency	String	Alphabet	M	3	Currency of amount based on ISO 4217.	IDR
>trxDateTime	String	Numeric	M	25	Transaction date time	2021-11 03T14: 10:23+07:00
>additionalinfo	Object		M		Additional Information for custom use
>>channel	String	Alphanumeric	M		Channel code payment BRI	TRFHMB
>>description	String	Alphanumeric	M	40		Keterangan
>>sourceAccountVa	String	Numeric	O	15	Additional description for create Briva	1040100 2213308
>>tellerId	String	Numeric	O		Teller Id BRI	0888901

Request & Response Payload Sample

Request :

 '{

    "partnerServiceId": " 88899",
    "startDate": "2021-12-06",
    "startTime": "14:56:00+07:00",
    "endDate": "2021-12-06",
    "endTime": "23:59:00+07:00"
    "additionalInfo": { 
      "uniqueCode": "test", 
      "customerCode": "test" 
  }
}'

Normal Response :

{

"responseCode": "2003500",
"responseMessage": "Successful",
"virtualAccountData": [

      {
            "partnerServiceId": "   77204",
            "customerNo": "2109180041",
            "virtualAccountNo": "   772042109180041",
            "virtualAccountName": "John Doe",
            "trxId": "2130780041019445767",
            "totalAmount": {
                "value": "1000000.00",
                "currency": "IDR"
            },
            "trxDateTime": "2021-11-03T14:10:23+07:00",
            "additionalInfo": {
                "channel": "TRFHMB",
                "description": "",
                "sourceAccountVa": "10401002213308",
                "tellerId": "0888232   "
            }
        },
        {
            "partnerServiceId": "   77204",
            "customerNo": "3403190112",
            "virtualAccountNo": "   772043403190112",
            "virtualAccountName": "John Doe",
            "trxId": "2130700000120006004",
            "totalAmount": {
                "value": "970000.00",
                "currency": "IDR"
            },
            "trxDateTime": "2021-11-03T14:32:07+07:00",
            "additionalInfo": {
                "channel": "TRFLA",
                "description": "",
                "sourceAccountVa": "10401002213308",
                "tellerId": "0888901   "
            }
        },
        {
            "partnerServiceId": "   77204",
            "customerNo": "3402180561",
            "virtualAccountNo": "   772043402180561",
            "virtualAccountName": "John Doe",
            "trxId": "2130788885010240889",
            "totalAmount": {
                "value": "315000.00",
                "currency": "IDR"
            },
            "trxDateTime": "2021-11-03T14:34:05+07:00",
            "additionalInfo": {
                "channel": "NBMB",
                "description": "",
                "sourceAccountVa": "10401002213308",
                "tellerId": "8888501   "
            }
        }

]

}

Error Response :

{
Response Code: 4003500,
Response Message: “Bad Request”,
}

List of Error/Response Code

HTTP Status	Service Code	Case Code	Status	Response Description
200	35	00	Success	Successful
400	35	00	Failed	Bad Request
400	35	01	Failed	Invalid Field Format
400	35	02	Failed	Invalid Mandatory Field
401	35	00	Failed	Unauthorized. Client Forbidden Access API
404	35	12	Failed	Invalid Bill/Virtual Account. [Reason]
404	35	13	Failed	Invalid Amount
404	35	16	Failed	Partner Not Found
409	35	01	Failed	Conflict
500	35	00	Pending	General Error
504	35	00	Pending	Timeout

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

G. Inquiry Status

Endpoint Description

This Endpoint is used to get the transaction status of BRIVA number that registered in BRI system (BRIVA WS).

General Information

HTTP Method	POST
Path	snap/v1.0/transfer-va/status
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	From Payment Request. Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo	___88899
customerNo	String	Numeric	M	13 Note: SNAP BI length (20)	Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo	1234582
virtualAccountNo	String	Numeric	M	28	partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo (kalau devportal BI partnerServiceId + customerNo)	___000891234582
inquiryRequestId	String	Alphanumeric	M	36 Note: SNAP BI length (128)	Unique identifier for this Inquiry. Generated by PJP.	065ad3ca-2490-4432-8a 29-0a9a7ce4904b

Response Structure

Field	Data Type	Format	Mandatory	Length	Description	Example
responseCode	String	Numeric	M	7	Response Code	2003500
responseMessage	String	Alphabet	M	150	Response Description	Successful
virtualAccountData	Object		M
>partnerServiceId	String	Numeric	M	8	Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo	___88899
>customerNo	String	Numeric	M	20	Unique number (up to 20 digits). partnerServi ceId + customerNo or virtualAccountNo	1234557767792
>virtualAccountNo	String	Numeric	M	28	partnerServi ceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccou ntNo	___888991234557
>inquiryRequestId	String	Alphanumeric	M	128	Unique identifier for this Inquiry. Generated by PJP.	065ad3ca-2490-4432-8a29-0a9a7ce4904b
>additionalInfo	Object		M		Additional Info
>>paidStatus	String	Alphabet	M	1	Paid status with letter Y or N

Request & Response Payload Sample

Request :

    {
        "partnerServiceId": " 00089",
        "customerNo": "1234582",   
        "virtualAccountNo": " 000891234582",
        "inquiryRequestId": "065ad3ca-2490-4432-8a29-0a9a7ce4904b"
      }

Normal Response :

    {
        "responseCode": "2002600", 
        "responseMessage": "Successful", 
        "virtualAccountData": {   
        "partnerServiceId": " 12348",
        "customerNo": "1234680",
        "virtualAccountNo": " 123481234680",
        "partnerReferenceNumber": "2020102900000000000004", 
        "paidAmount": {
        "value": "10000.00",
        "currency": "IDR"
        },
        "trxDateTime": "2022-02-28T22:38:25+07:00",
        "paymentFlagStatus": "00",
        "inquiryRequestId": "065ad3ca-2490-4432-8a29-0a9a7ce4904b"
        }
    }

Error Response :

    {
        "responseCode": "4002602",   
        "responseMessage": "Invalid Mandatory Field partnerServiceId"
        }

List of Error/Response Code

HTTP Status	Service Code	Case Code	Status	Response Description
200	26	00	Success	Successful
400	26	00	Failed	Bad Request
400	26	01	Failed	Invalid Field Format
400	26	02	Failed	Invalid Mandatory Field
401	26	00	Failed	Unauthorized. Client Forbidden Access API
404	26	12	Failed	Invalid Bill/Virtual Account {Reason}
404	26	13	Failed	Invalid Amount
409	26	01	Failed	Conflict
500	26	00	Pending	General Error
504	26	00	Pending	Timeout

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