APIDOCS Virtual Account/Briva WS SNAP BI

Buat API

Informasi API

Judul

API Briva WS

Versi

v1.0

URL Sandbox

https://sandbox.partner.api.bri.co.id

URL Production

  

Kendali Versi

 

Versi Dok

Versi API

Tanggal

Tautan dokumen

Deskripsi

v1.0.0

v1.0

14 Desember 2021

Halaman ini

Baseline version.

v1.0.1

v1.0

22 April 2022

Halaman ini

Update field format
v1.0.2 v1.0 10 Maret 2023 Halaman ini Mengubah path endpoint Create VA,Update VA,Update Status VA, Inquiry VA, Delete VA, Get Report, dan Inqury Status
v1.0.3 v1.0 06 September 2023 Halaman ini Penyesuaian example Response Error untuk Invalid Bill/Virtual Account.

Deskripsi Produk

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

 

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

Endpoint ini digunakan untuk membuat virtual account BRI baru

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

Key

Date Type

Format

Mandatory

Length

Deskripsi

Contoh

partnerServiceId

String

Numeric

M

8

Turunan X-PARTNER-ID, mirip dengan kode perusahaan. 8 digit left padding space.partnerServiceId + customerNo atau virtualAccountNo

___77777

customerNo

String

Numeric

M

13

Note: SNAP BI

length

(20)

Nomor unik (hingga 20 digit)

 

partnerServiceId + customerNo atau virtualAccontNo

28138102

virtualAccountNo

String

Numeric

M

28

partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo atau virtualAccountNo

___7777728138 102

totalAmount

Object

 

M

Note :

SNAP

BI

(O)

 

 

 

>value

String

Numeric

M

15,2

Note: SNAP BI

length

(16,2)

Jumlah transaksi. jumlah total dengan dua desimal

10000.00

>currency

String

Alphabet

M

3

Jumlah mata uang berdasarkan ISO 4217

IDR

virtualAccountName

String

Alphanumeric

M

40

Note: SNAP BI

length

(255)

Nama customer

John Doe

expiredDate

String

Numeric Date

M

Note:

SNAP BI

(O)

25

Jumlah transaksi. jumlah total dengan dua desimal

2022-02-28T22:

38:25+07:00

trxId

String

Alphanumeric

M

64

ID transaksi di Partner system

abcdefgh1234

additionalInfo

String

 

M

Note :

 SNAP

BI

(O)

 

Informasi tambahan untuk pengguna khusus

 

>description

String

Alphanumeric

M

40

Deskripsi tambahaan untuk pembuatan briva

Keterangan

Response Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

ResponCode

2002700

responseMessage

String

Alphabet

M

150

Respon Deskripsi

Successful

virtualAccountData

Object

 

M

 

 

 

>partnerServiceId

String

Numeric

M

8

Turunan X-PARTNER-ID, mirip dengan kode perusahaan. 8 digit left padding space.partnerServiceId + customerNo atau virtualAccountNo

___77777

>customerNo

String

Numeric

M

13

 

Note: SNAP BI

length

20

Nomor unik (hingga 20 digit)

 

partnerServiceId + customerNo atau virtualAccontNo

28138102

>virtualAccountNo

String

Numeric

M

28

partnerServiceId (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)

Nama customer

John Doe

>trxId

String

 

M

32

Request pembuatan VA

abcdefgh1234

>totalAmount

Object

Alphabet

M

Note: SNAP BI (O)

 

 

 

>>value

String

Numeric

M

15,2

Note: SNAP BI

length

(16,2)

Jumlah transaksi. jumlah total dengan dua desimal

1000000000

000

>>currency

String

 

M

3

Mata uang. Jumlah mata uang berdasarkan ISO 4217

IDR

>expiredDate

String

Numeric Date

M

Note: SNAP BI (O)

25

 

2022-02-

28T22:38:

25Z

>additionalInfo

Object

 

M

 

Informasi tambahan untuk pengguna khusus

 

>>description

String

Alphanumeric

M

40

Deskripsi tambahaan untuk pembuatan briva

Keterangan

Request & Response Payload Sample

Request :

{
    "partnerServiceId": "   77777",
    "customerNo": "28138102",
    "virtualAccountNo": "   7777728138102",
    "virtualAccountName": "John Doe ",
    "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

Deskripsi

200

27

00

Sukses

Successful

  

400

27

00

Gagal

Bad Request

  

400

27

01

Gagal

Invalid Field Format 

  

400

27

02

Gagal

Invalid Mandatory Field

  

401

27

00

Gagal

Unauthorized. Client Forbidden Access API

  

404

27

12

Gagal

Invalid Bill/Virtual Account

  

404

27

13

Gagal

Invalid Amount

  

404

27

16

Gagal

Partner Not Found

  

409

27

01

Gagal

Conflict

  

500

27

00

Pending

General Error

  

504

27

00

Pending

Timeout

  
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

B. Update VA

Endpoint Description

Endpoint ini digunakan untuk mengupdate detail akun BRIVA yang sudah ada

General Information

HTTP Method

POST

Path

snap/prod/v1.0/transfer-va/update-va

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Request Structure

Key

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

Note: SNAP BI

length

(20)

Nomor unik (hingga 20 digit)

 

partnerServiceId + customerNo atau virtualAccontNo

181381003

virtualAccountNo

String

Numeric

M

28

partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo

___7777718138 1003

virtualAccountName

String

Alphanumeric

M

40

Note: SNAP BI

length

(255)

Nama customer

John Doe

totalAmount

Object

 

M

Note: SNAP BI (O)

 

 

 

value

String

Numeric

M

15,2

Note: SNAP BI length

(16,2)

Jumlah transaksi. jumlah total dengan dua desimal (ISO4217)

1000.00

currency

String

Alphabet

M

3

Mata uang. Jumlah mata uang berdasarkan ISO 4217

IDR

trxId

String

Alphanumeric

M

64

ID transaksi di Partner system

abcdefgh1234

expiredDate

String

Numeric Date

M

Note : SNAP BI (O)

25

Tanggal kadaluarsa akun virtual. ISO-8601

022-02-28T22:

38:25+07:00

additionalInfo

String

 

M

Note : SNAP BI (O)

 

Informasi tambahan untuk pengguna khusus

 

>description

String

Alphanumeric

M

40

Deskripsi tambahaan untuk pembuatan briva

Keterangan

Response Structure

Field

Data Type

Format

Mandatory

Length

Desckripsi

Contoh

responseCode

String

Numeric

M

7

responseCode

2002800

responseMessage

String

Alphabet

M

150

Response Deskripsi

Successful

virtualAccountData

Object

 

M

 

 

 

>partnerServiceId

String

Numeric

M

8

Turunan X-PARTNER-ID, mirip dengan kode perusahaan. 8 digit left padding space.partnerServiceId + customerNo atau virtualAccountNo

___77777

>customerNo

String

Numeric

M

13

Note: SNAP BI

length

(20)

Nomor unik (hingga 20 digit)

 

partnerServiceId + customerNo atau virtualAccontNo

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)

Nama Customer

John Doe

>trxId

String

Alphanumeric

M

32

ID transaksi di Partner system

abcdefgh1234

>totalAmount

Object

 

M

Note : SNAP BI (O)

 

 

 

>>value

String

Numeric

M

15,2

Note: SNAP BI

length

(16,2)

Mata uang. Jumlah mata uang berdasarkan ISO 4217 (ISO4217)

1000.00

>>currency

String

Alphabet

M

3

Mata uang. Jumlah mata uang berdasarkan ISO 4217

IDR

>expiredDate

String

Numeric

M

Note : SNAP BI (O)

25

Tanggal kadaluarsa akun virtual. ISO-8601

2022-02-28T22:

38:25+07:00

>additionalInfo

Object

 

M

Note : SNAP BI (O)

 

Informasi tambahan untuk pengguna khusus

 

>>description

String

Alphanumeric

M

40

Deskripsi tambahaan untuk pembuatan 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

Deskripsi

200

28

00

Sukses

Successful

  

400

28

00

Gagal

Bad Request

  

400

28

01

Gagal

Invalid Field Format 

  

400

28

02

Gagal

Invalid Mandatory Field

  

401

28

00

Gagal

Unauthorized. Client Forbidden Access API

  

404

28

12

Gagal

Invalid Bill/Virtual Account

  

404

28

13

Gagal

Invalid Amount

  

404

28

16

Gagal

Partner Not Found

  

409

28

01

Gagal

Conflict

  

500

28

00

Pending

General Error

  

504

28

00

Pending

Timeout

  
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

C. Update Status VA

Endpoint Description

Endpoint ini digunakan untuk mengelola status pembayaran rekening BRIVA yang ada

General Information

HTTP Method

POST

Path

snap/v1/transfer-va/update-status

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Request Structure

Key

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

Note: SNAP BI length

(20)

Nomor unik (hingga 20 digit)

 

partnerServiceId + customerNo atau virtualAccontNo

08138598

virtualAccountNo

String

Numeric

M

28

28 partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo

___7777708 138598

trxId

String

Alphanumeric

M

64

ID transaksi di Partner system

abcdefgh12 34

paidStatus

String

Alphabet

M

1

Y = Paid

N = Not Paid

Y

Response Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseMessage

String

Alphabet

M

150

Response Deskripsi

2002900

responseCode

String

Numeric

M

7

Response Code

Successful

virtualAccountData

Object

 

M

 

 

 

>partnerServiceId

String

Numeric

M

8

Turunan X-PARTNER-ID, mirip dengan kode perusahaan. 8 digit left padding space.p artnerServiceId + customerNo atau virtualAccountNo

___77777

>customerNo

String

Numeric

M

13

Note: SNAP

BI length

(20)

Nomor unik (hingga 20 digit)

partnerServiceId + customerNo atau virtualAccontNo

08138598

>virtualAccountNo

String

Numeric

M

28

partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits).

partnerServiceId + customerNo or virtualAccountNo

___777770 8138598

>trxId

String

Alphanumeric

M

64

ID transaksi di Partner system

abcdefgh1 234

>additionalInfo

Object

 

O

 

Informasi tambahan untuk pengguna khusus

 

>>paidStatus

Alphabet

Alphabet

M

1

Transaksi status bayar

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

Deskripsi

200

29

00

Sukses

Successful

  

400

29

00

Gagal

Bad Request

  

400

29

01

Gagal

Invalid Field Format 

  

400

29

02

Gagal

Invalid Mandatory Field

  

401

29

00

Gagal

Unauthorized. Client Forbidden Access API

  

404

29

12

Gagal

Invalid Bill/Virtual Account

  

404

29

13

Gagal

Invalid Amount

  

404

29

16

Gagal

Partner Not Found

  

409

29

01

Gagal

Conflict

  

500

29

00

Pending

General Error

  

504

29

00

Pending

Timeout

  
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

D. Inquiry VA

Endpoint Description

Endpoint ini digunakan untuk mendapatkan informasi virtual account yang telah dibuat

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

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

Note: SNAP BI length

(20)

Nomor unik (hingga 20 digit)

 

partnerServiceId + customerNo atau virtualAccontNo

08138594

virtualAccountNo

String

Numeric

M

28

28 partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccou ntNo

___7777708 138594

trxId

String

Alphanumeric

M

64

ID transaksi di Partner system

abcdefgh12 34

Response Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Response code

Successful

responseMessage

String

Alphabet

M

150

Response Deskripsi

2003000

virtualAccountData

Object

 

M

 

 

 

>partnerServiceId

String

Numeric

M

8

Turunan X-PARTNER-ID, mirip dengan kode perusahaan. partnerServiceId + customerNo or virtualAccountNo

___77777

>customerNo

String

Numeric

M

13

Note:

SNAP BI

length

(20)

Nomor unik (hingga 20 digit)

partnerServiceId + customerNo atau virtualAccontNo

08138594

>virtualAccountNo

String

Numeric

M

28

28 partnerServi ceId (8 digit left padding 0) + customerNo (up to 20 digits).
partnerServi ceId + customerNo or virtualAccou ntNo

___777770813 8594

>virtualAccountName

String

Alphanumeric

M

40

Note:

SNAP BI

length

(255)

Nama Customer

Jokul Doe

>trxId

String

Alphanumeric

M

32

ID transaksi di Partner system

abcdefgh1234

>totalAmount

String

 

M

Note : SNAP BI (O)

 

 

 

>>value

String

Numeric

M

15,2

Note: SNAP BI

length

(16,2)

Jumlah tagihan dengan dua desimal (ISO 4217)

1000000000000.

00

>>currency

String

Alphabet

M

3

Mata uang. Jumlah mata uang berdasarkan ISO 4217

IDR

>expiredDate

String

Numeric Date

M

Note : SNAP BI (O)

25

Tanggal kadaluarsa akun virtual. ISO-8601

2022-02-28T22:

38:25+07:00

>additionalInfo

String

 

M

Note : SNAP BI (O)

 

Informasi tambahan untuk pengguna khusus

 

>>description

String

Alphanumeric

M

40

Deskripsi tambahaan untuk pembuatan 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": "Jokul 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

Deskripsi

200

30

00

Sukses

Successful

  

400

30

00

Gagal

Bad Request

  

400

30

01

Gagal

Invalid Field Format 

  

400

30

02

Gagal

Invalid Mandatory Field

  

401

30

00

Gagal

Unauthorized. Client Forbidden Access API

  

404

30

12

Gagal

Invalid Bill/Virtual Account

  

404

30

13

Gagal

Invalid Amount

  

404

30

16

Gagal

Partner Not Found

  

409

30

01

Gagal

Conflict

  

500

30

00

Pending

General Error

  

504

30

00

Pending

Timeout

  
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

E. Delete VA

Endpoint Description

Endpoint ini digunakan untuk menghapus data BRIVA yang ada

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

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

Note: SNAP BI

length

(20)

Noor unik (hingga angka 20). partnerServi ceId + 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

O

 

64

ID transaksi di Partner system

abcdefgh1234

Response Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Response Code

2003100

responseMessage

String

Alphabet

M

150

Response Deskripsi

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

>customer No

String

Numeric

M

13

Note: SNAP BI length

(20)

Nomor unik (hingga 20 angka). partnerServiceId + customerNo or virtualAccountNo

08138594

>virtualAccountNo

String

Numeric

M

28

28 partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo

___777770 8138594

> trxId

String

Alphanumeric

O

 

64

ID transaksi di Partner system

abcdefgh12 34

additionalInfo

Object

 

O

 

Informasi tambahan untuk pengguna khusus

 

description

String

Alphanumeric

M

40

Deskripsi tambahan untuk pembuatan 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",
        "trxId": "abcdefgh1234",
     "additionalInfo": {
            "description": "keterangan"
          }
       }
   }

Error Response :

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

List of Error/Response Code

HTTP Status

Service
Code

Case Code

Status

Response Description

Deskripsi

200

31

00

Suckses

Successful

  

400

31

00

Gagal

Bad Request

  

400

31

01

Gagal

Invalid Field Format 

  

400

31

02

Gagal

Invalid Mandatory Field

  

401

31

00

Gagal

Unauthorized. Client Forbidden Access API

  

404

31

12

Gagal

Invalid Bill/Virtual Account

  

404

31

13

Gagal

Invalid Amount

  

404

31

16

Gagal

Partner Not Found

  

409

31

01

Gagal

Conflict

  

500

31

00

Pending

General Error

  

504

31

00

Pending

Timeout

  
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

F. Get Report

Endpoint Description

Endpoint ini digunakan untuk mendapatkan history transaksi semua rekening BRIVA yang terdaftar di nomor BRIVA pengguna

 

Note : 
- get report belum 24 jam
- ada pengurangan time 10 menit dan 5 menit dari delay waktu payment

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

Deskripsi

Contoh

partnerServiceId

String

Numeric

M

8

Turunan X-PARTNER-ID, mirip dengan kode perusahaan. 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo

___88899

startDate

String

Numeric Date

M

Note : SNAP BI (O)

10

Start Date for Report yyyy-MM-dd

2021-12-

06

startTime

String

Numeric Date

M

Note : SNAP BI (O)

5

Start Time for Report. HH:mm If used, must send startDate If startDate exists without startTime, default startTime = 00:00

Note : BRI hanya memfilter field ini hingga menit

07:00

endTime

String

Numeric Date

M

Note : SNAP BI (O)

5

End Time for Report. HH:mm If used, must send endDate. If endDate exists

Note: BRI hanya memfilter field ini hingga menit

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

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Response Code

2003500

responseMessage

String

Alphabet

M

150

Response Deskripsi

Successful

virtualAccountData

Array of Object

 

M

 

 

 

>partnerServiceId

String

Numeric

M

8

Derivative of XPARTNERID , similar to company code, 8 digit left padding space. partnerServi ceId + customerNo or virtualAccou ntNo

___88899

>customerNo

String

Numeric

M

20

Nomor unik (hingga angka 20). partnerServiceId + customerNo or virtualAccountNo

1234557767792

>virtualAccountNo

String

Numeric

M

28

partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo

___8889912345 57767792

>virtualAccountName

String

Alphanumeric

M

255

nama customer

John Doe

>trxId

String

Alphanumeric

M

Note: 

SNAP BI

(O)

64

Transaction ID

2130780041019

445767

>totalAmount

Object

 

M

Note: 

SNAP BI

(O)

 

 

 

>>value

String

Numeric

M

15,2

Note: SNAP BI

length

(16,2)

Jumlah tagihan dengan dua desimal

10.00

>>currency

String

Alphabet

M

3

Mata uang. Jumlah mata uang berdasarkan ISO 4217

IDR

>trxDateTime

String

Numeric

M

25

Transaction date time

2021-11-03T14:

10:23+07:00

>additionalinfo

Object

 

M

 

Informasi tambahan untuk pengguna khusus

 

>>channel

String

Alphanumeric

M

 

Channel code payment BRI

TRFHMB

>>description

String

Alphanumeric

M

40

 

Keterangan

>>sourceAccountVa

String

Numeric

O

15

Deskripsi tambahan untuk pembuatan briva

 

>>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": "TANTRI DEVI MILE", 
"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": "", 
"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

Deskripsi

200

35

00

Sukses

Successful

  

400

35

00

Gagal

Bad Request

  

400

35

01

Gagal

Invalid Field Format 

  

400

35

02

Gagal

Invalid Mandatory Field

  

401

35

00

Gagal

Unauthorized. Client Forbidden Access API

  

404

35

12

Gagal

Invalid Bill/Virtual Account

  

404

35

13

Gagal

Invalid Amount

  

404

35

16

Gagal

Partner Not Found

  

409

35

01

Gagal

Conflict

  

500

35

00

Pending

General Error

  

504

35

00

Pending

Timeout

  
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

G. Inquiry Status

Endpoint Description

Endpoint ini digunakan untuk mendapatkan status transaksi nomor BRIVA yang terdaftar di sistem BRI (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

Deskripsi

Contoh

partnerServiceId

String

Numeric

M

8

Dari Permintaan Pembayaran. Turunan dari XPARTNERID , mirip dengan kode perusahaan, 8 digit ruang padding kiri. partnerServiceId + customerNo atau virtualAccountNo

___88899

customerNo

String

Numeric

M

13

Note:

SNAP BI

length

(20)

Nomor unik (hingga angka 20). 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

___000891234582

inquiryRequestId

String

Alphanumeric

M

36

Note:

SNAP BI

length

(128)

Pengidentifikasi unik untuk Inquiry. Dibuat oleh PJP.

065ad3ca-2490-

4432-8a29-

0a9a7ce4904b

Response Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Response Code

2003500

responseMessage

String

Alphabet

M

150

Response Description

Successful

virtualAccountData

Object

 

M

 

 

 

>partnerServiceId

String

Numeric

M

8

Dari Permintaan Pembayaran. Turunan dari XPARTNERID , mirip dengan kode perusahaan, 8 digit ruang padding kiri. partnerServiceId + customerNo atau virtualAccountNo

___88899

>customerNo

String

Numeric

M

20

Nomor unik (hingga angka 20). 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

>inquiryRequestId

String

Alphanumeric

M

128

Pengidentifikasi unik untuk Inquiry. Dibuat oleh PJP.

065ad3ca-2490-4432-8a29-

0a9a7ce

4904b

>additionalInfo

Object

 

M

 

 

 

>>paidStatus

String

Alphabet

M

1

Status dibayar dengan Y dan 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

Deskripsi

200

26

00

Sukses

Successful

 

400

26

00

Gagal

Bad Request

 

400

26

01

Gagal

Invalid Field Format

 

400

26

02

Gagal

Invalid Mandatory Field

 

401

26

00

Gagal

Unauthorized. Client Forbidden Access API

 

404

26

12

Gagal

Invalid Bill/Virtual Account {Reason}

 

404

26

13

Gagal

Invalid Amount

 

409

26

01

Gagal

Conflict

 

500

26

00

Pending

General Error

 

504

26

00

Pending

Timeout

 
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan