Virtual Account/Notification for Payment (Push Notif)

Informasi API

Judul

APIdocs Virtual Account/Notification for Payment (Push Notif)

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

v1.0

14 Desember 2021

Halaman Ini

Baseline version.

v2.0

v1.0

26 April 2022

Halaman ini

Update field format

v3.0 v1.0 29 Jan 2024 Halaman ini Update field virtualAccountData di Response Structure

Product Description

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

 

Alphanumeric

M

12

 

Endpoint

Notification Payment to VA Intrabank

Endpoint Description

Endpoint ini digunakan untuk melaporkan notifikasi status pembayaran ke VA dari 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

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

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

2023-12-04T08:34:00+07:00

paymentRequestId

String

Alphanumeric

O

128

transaksiID dihasilkan oleh PJP, ID unik untuk setiap transaksi

2027912345671234567

additionalInfo

Object

 

O

 

 

 

>idApp

String

Alphanumeric

M

8

Bank identifier dari pihak ketiga

24123244

>passApp

String

Alphanumeric

M

64

Kunci dari pihak ketiga untuk mengakses API

354324134

>paymentAmount

String

Numeric

M

10

Jumlah pembayaran

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’ untuk BRI) 002

Response Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

response code

2003400

responseMessage

String

Alphabet

M

150

response description

Successful

virtualAccountData

Object

 

O

 

 

 

>partnerServiceId

String

Numeric

M

8

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

___77777

>customerNo

String

Numeric

M

13

Notes : SNAP BI

length

 

(20)

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

dari inquiry request

abcdef-123456-abcdef

>paymentRequestId

String

Numeric

M

Notes :

SNAP BI (O)

30

Notes :

SNAP BI

length

(128)

Pengenal unik untuk Pembayaran. Dihasilkan oleh PJP

2027912345671234567

>trxDateTime

Date

Numeric

M

25

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

2023-12-04T08:34:00+07:00

>paymentStatus

String

Alphabet

O

20

Status permintaan pembayaran

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

Deskripsi

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

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