APIDOCS Virtual Account/Transfer to VA SNAP BI

Buat API

Informasi API

Judul

APIdocs Virtual Account/Transfer to VA

Versi

v1.0

URL Sandbox

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

URL Production

  

Version Control

 

Versi Dok

Versi API

Tanggal

Tautan Dokumen

Deskripsi

v1.0

v1.0

14 Desember 2021

Halaman ini

Baseline version.

v2.0

v1.0

12 May 2022

Halaman ini

Update field format
v2.1 v1.0 05 Jan 2023 Halaman ini Update length
v3.0 v1.0 10 Mar 2023 Halaman ini  Mengubah path pada Inquiry Payment to VA from Intrabank dan Payment To VA Intrabank

Product Description

Deskripsi 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

 

Numeric

          M

9

 

Endpoint

A. Inquiry Payment to VA from Intrabank

Endpoint Description

Endpoint ini digunakan untuk memvalidasi akun virtual

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

Deskripsi

Contoh

partnerServiceId

String

Numeric

     M

8

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

88899

customerNo

String

Numeric

     M

13
Notes :
SNAP BI
length
(20)

Nomor unik (hingga 20 digit)

partnerServiceId + customerNo atau virtualAccontNo

1234572

virtualAccountNo

String

Numeric

     M

21
Notes :
SNAP BI
length
(28)

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

___87777712345600

Response Structure

Field

Data Type

Format

Mandatory

Length

Deskrispi

Contoh

responseCode

String

Numeric

     M

7

Respon Code

2003200

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
Notes :
SNAP BI
length
(20)

Nomor unik (hingga 20 digit)

partnerServiceId + customerNo atau virtualAccontNo

12345600

>virtualAccountNo

String

Numeric

     M

21
Notes :
SNAP BI
length
(28)

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

 

7777712345600

>virtualAccountName

String

Alphanumeric

     M

   Notes :

  SNAP BI 

     (O)

250
Notes :
SNAP BI
length
(255)

Nama customer

Jokul Doe

>>value

String

Numeric

     O

15,2
Notes :
SNAP BI
length
(16,2)

 

Jumlah transaksi

10000000000.00

>>currency

String

Alphabet

     O

3

Mata uang

IDR

>additionalInfo

Object

 

     O

 

 

 

>>description

String

Alphanum eric

     O

40

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

Deskripsi

200

32

00

Sukses

Successful

  

400

32

00

Gagal

Bad Request

  

400

32

01

Gagal

Invalid Field Format

  

400

32

02

Gagal

Invalid Mandatory Field

  

404

32

12

Gagal

Invalid Bill/Virtual Account

  

404

32

14

Gagal

Paid Bill

  

404

32

19

Gagal

Expired Bill

  

409

32

00

Gagal

Conflict

  

504

32

00

Gagal

Timeout

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

B. Payment To VA Intrabank

Endpoint Description

Endpoint ini digunakan untuk melakukan transfer ke akun virtual

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

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 atau virtualAccontNo

18138200

virtualAccountNo

String

Numeric

M

21
Notes :
SNAP BI
length
(28)

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

 7777718138200

virtualAccountName

String

Alphanumeric

M

250

Nama customer

Jokul Doe

sourceAccountNo

String

Numeric

M

15
Notes :
SNAP BI
length
(32)

Nomor akun Pengirim

020601000127303

partnerReferenceNumber

String

Numeric

M

28

Unique identifier untuk pembayaran ini dihasilkan oleh mitra

2261110855

paidAmount

Object

 

      

 

>value

String

Numeric

M

15,2
Notes :
SNAP BI
length
(16,2)

Jumlah Transaksi

10001.00

>currency

String

Alphabet

M

3

Mata Uang

IDR

trxDateTime

Date

Numeric

M

25

Tanggal waktu sistem PJP dengan zona waktu yang mengikuti standar ISO-8601

2022-01-21T08:30:25+07.00

Response Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Respon Code

2003300

responseMessage

String

Alphabet

M

150

Respon Deskripsi

Successful

virtualAccountData

Object

 

      

 

>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
Notes :
SNAP BI
length
(20)

Nomor unik (hingga 20 digit) partnerServiceId + customerNo atau virtualAccontNo

18138200

>virtualAccountNo

String

Numeric

M

21
Notes :
SNAP BI
length
(28)

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

77777181382003300

>virtualAccountName

String

Alphanumeric

M

250

Nama Customer

Jokul Doe

>paidAmount

Object

 

 O    

 

>>value

String

Numeric

M

15,2
Notes :
SNAP BI
length
(16,2)

Jumlah transaksi dari permintaan pembayaran

10000.00

>>currency

String

Alphabet

M

3

Mata uang

IDR

trxDateTime

Date

Numeric

M

25

Tanggal waktu sistem PJP dengan zona waktu yang mengikuti standar ISO-8601

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

Deskripsi

200

33

00

Sukses

Success

  

400

33

00

Gagal

Bad Request

  

400

33

01

Gagal

Invalid Field Format

  

400

33

02

Gagal

Invalid Mandatory Field

  

403

33

02

Gagal

Exceeds Transaction Amount Limit

  

403

33

09

Gagal

Dormant Account

  

403

33

14

Gagal

Insufficient Funds

  

403

33

15

Gagal

Transaction Not Permitted

  

403

33

16

Pending

Suspend Transaction

  

403

33

18

Gagal

Inactive Card/Account/Customer

  

404

33

11

Gagal

Invalid Card/Account/Customer [info]/Virtual Account

  

404

33

12

Gagal

Invalid Bill/Virtual Account

  

404

33

13

Gagal

Invalid Amount

  

404

33

14

Gagal

Paid Bill

  

404

33

19

Gagal

Expired Bill

  

409

33

00

Gagal

Conflict

  

500

33

00

Pending

General Error

  

500

33

01

Pending

Unknown Error

  

504

33

00

Pending

Timeout

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