APIDOCS Virtual Account/Transfer to VA SNAP BI

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
v4.0 v1.1 24 Jan 2024 Halaman ini
  • penyesuaian path Inquiry Payment to VA from Intrabank
  • penyesuaian mandatory field totalAmountvalue, dan currency pada response Inquiry Payment to VA from Intrabank
  • penyesuaian path Payment to VA from Intrabank
  • penyesuaian mandatory field virtualAccountNametrxDateTime, dan currency pada request Payment to VA from Intrabank
  • penyesuaian field partnerReferenceNumber menjadi partnerReferenceNo pada Payment to VA from Intrabank
  • penambahan field paymentRequestId pada response Payment to VA from Intrabank

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

 

 

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.1/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

___77777

customerNo

String

Numeric

     M

13
Notes :
SNAP BI
length
(20)

Nomor unik (hingga 20 digit)

partnerServiceId + customerNo atau virtualAccontNo

20098115

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

___7777720098115

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

20098115

>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

 

___7777720098115

>virtualAccountName

String

Alphanumeric

     M

   Notes :

  SNAP BI 

     (O)

250
Notes :
SNAP BI
length
(255)

Nama customer

Jokul Doe

>totalAmount

Object

 

M
Notes : SNAP BI (O)

 

 

 

 

>>value

String

Numeric

M

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

 

Jumlah transaksi

10000.00

>>currency

String

Alphabet

     M

3

Mata uang

IDR

>additionalInfo

Object

 

     O

 

 

 

>>description

String

Alphanumeric

     O

40

Deskripsi tambahaan untuk pembuatan briva

Keterangan

Request & Response Payload Sample

Request 

{
  "partnerServiceId": "   77777",
  "customerNo": "20098115",
  "virtualAccountNo": "   7777720098115"
}

Normal Response :

{
  "responseCode": "2003200",
  "responseMessage": "Successful",
  "virtualAccountData": {
    "partnerServiceId": "   77777",
    "customerNo": "20098115",
    "virtualAccountNo": "   7777720098115",
    "virtualAccountName": "tes surya",
    "totalAmount": {
      "value": "10000.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

Pending

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.1/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

20098115

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

 ___7777720098115

virtualAccountName

String

Alphanumeric

M

Notes :

SNAP BI (O)

250

Notes :

SNAP BI length

(255)

Nama customer

Jokul Doe

sourceAccountNo

String

Numeric

M

Notes :

SNAP BI (O)

15
Notes :
SNAP BI
length
(32)

Nomor akun Pengirim

001901000032531

partnerReferenceNo

String

Numeric

M

28

Notes :

SNAP BI length

(128)

Unique identifier untuk pembayaran ini dihasilkan oleh mitra

2261110858

paidAmount

Object

 

M    

 

>value

String

Numeric

M

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

Jumlah Transaksi

10000.00

>currency

String

Alphabet

M

3

Mata Uang

IDR

trxDateTime

Date

Numeric

M

Notes :

SNAP BI (O)

25

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

2023-10-25T17:26:00+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

 

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

20098115

>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

___7777720098115

>virtualAccountName

String

Alphanumeric

M

250

Notes :

SNAP BI length

(255)

Nama Customer

Jokul Doe

>partnerReferenceNo

String

Numeric

M 28

Notes :

SNAP BI length

(128)

Dari payment request

2261110858

>paymentRequestId

String

Numeric

M

Notes :

SNAP BI (O)

11

Notes :

SNAP BI length

(128)

ID request unik ketika dilakukan proses payment 1705545600

>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 O 25 Tanggal waktu sistem PJP dengan zona waktu yang mengikuti standar ISO-8601 2023-10-25T17:26:00+07:00

Request & Response Payload Sample

Request 

{
  "partnerServiceId": "   77777",
  "customerNo": "20098115",
  "virtualAccountNo": "   7777720098115",
  "virtualAccountName": "test",
  "sourceAccountNo": "001901000032531",
  "partnerReferenceNo": "2261110858",
  "trxDateTime": "2023-10-25T17:26:00+07:00",
  "paidAmount": {
    "value": "10000.00",
    "currency": "IDR"
  }
}

Normal Response :

{
  "responseCode": "2003300",
  "responseMessage": "Successful",
  "virtualAccountData": {
    "partnerServiceId": "   77777",
    "customerNo": "20098115",
    "virtualAccountNo": "   7777720098115",
    "partnerReferenceNo": "2261110858",
    "virtualAccountName": "tes surya",
    "paidAmount": {
      "value": "10000.00",
      "currency": "IDR"
    },
    "trxDateTime": "2023-10-25T17:26:00+07:00",
    "paymentRequestId": "1705545600"
  }
}

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

 

504

33

00

Pending

Timeout

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