Temukan Dokumentasi BRIVA Di Sini

Apa itu BRIVA?

Teknologi transaksi keuangan telah berkembang secara pesat. Dulu, untuk melakukan sebuah transaksi digital Anda harus pergi ke kantor cabang atau ke ATM. Saat ini, telah hadir berbagai solusi untuk menyelesaikan transaksi digital yang mudah dan praktis, salah satunya adalah fitur virtual account.

Virtual account adalah akun rekening bank virtual yang umumnya berbentuk sejumlah nomor ID yang bisa digunakan untuk melakukan pembayaran. Nomor ID tersebut biasanya dibuat oleh bank yang dipilih sesuai permintaan perusahaan untuk melakukan transaksi. Dalam setiap transaksi, masing-masing pelanggan akan memperoleh ID yang berbeda untuk melakukan pembayaran. Nomor ID ini juga dapat berubah untuk transaksi yang berbeda

Metode pembayaran dan transaksi melalui virtual account adalah pilihan yang tepat bagi kita saat ini. Apalagi mengingat betapa perkembangan teknologi yang begitu pesat, dan digitalisasi yang mulai merata di semua lapisan masyarakat. Selain praktis dan mudah, menggunakan virtual account lebih personal serta terjamin keamanannya.

Contoh Penggunaan API BRIVA

Jika bisnis digital Anda bergerak di bidang e-commerce maupun marketplace, penggunaan API BRIVA akan memudahkan segala transaksi yang terjadi. Kemudahan ini akan dirasakan baik itu oleh pemilik bisnis maupun konsumen. Pemilik bisnis akan mendapatkan informasi mengenai transaksi apa saja yang terjadi secara lebih mudah dan cepat. Misalnya yang paling dasar adalah informasi mengenai dana masuk dan dana keluar. Sedangkan dari sisi konsumen, penggunaan API BRIVA akan mempercepat proses transaksi, karena setelah transfer tidak perlu lagi melakukan konfirmasi pembayaran melalui pengiriman buktinya.

Informasi API

Judul	BRIVA
Versi	v1.0
URL Sandbox	https://sandbox.partner.api.bri.co.id/v1/briva
URL Production	https://partner.api.bri.co.id/v1/briva

Kendali Versi

Versi Dok	Versi API	Tanggal	Tautan Dokumen	Deskripsi
v1.0	v1.0	1 February 2019	Halaman Ini	Versi Awal
v1.1	v1.0	30 Juli 2021	Halaman ini	Menambahkan validasi baru di setiap endpoint Menambahkan validasi baru untuk expired date lebih dari 3 bulan Update tipe data Amount, dari decimal ke integer Penambahan Response Code baru untuk pengecekkan Amount (Cek di sini)
v1.2	v1.1	12 Juni 2023	Halaman ini	Mengganti validasi expired date dari 3 bulan menjadi 60 bulan

Unduh Postman

Deskripsi Produk

API ini memungkinkan Anda untuk menggunakan layanan rekening virtual BRI (BRIVA) untuk mempermudah dan mempercepat aktivitas keuangan. API ini juga memiliki kelebihan dibandingkan dengan transfer manual, misalnya Anda tidak perlu melakukan konfirmasi pembayaran secara manual karena akan terverifikasi secara otomatis.

Flow API

A. Create

Penjelasan Endpoint

Endpoint ini digunakan untuk membuat virtual account BRI baru.

Informasi Umum

HTTP Method	POST
Path	/v1/briva
Tipe Format	JSON
Authentication	OAuth 2.0 with Access Token

Header Structure

Key	Value	Mandatory	Length	Deskripsi
Authorization	Bearer {token}	Ya		Access Token
BRI-Timestamp		Ya		Timestamp dengan format ISO8601
BRI-Signature		Ya	64	Signature
Content-Type	application/json	Ya

Request Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
nama	String	40	Ya	Nama nasabah untuk nomor rekening BRIVA tersebut
amount	Numeric		Ya	Jumlah nominal untuk nomor BRIVA Note : Tidak boleh ada tanda titik (.) maupun koma (,) pada isian amount
keterangan	String		Ya	Keterangan dari nomor BRIVA
expiredDate	DateTime		Ya	Tanggal kadaluarsa untuk akun BRIVA tersebut, format: yyyy-MM-dd HH:mm:ss

Response Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
status	bool	5	Ya	True / False
responseDescription	String		Ya	Penjelasan Respon
responseCode	String		Ya	Kode Respon
statusBayar	string		Ya	Status pembayaran, Y berarti sudah dibayar dan N berarti belum dibayar
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
nama	String	40	Ya	Nama nasabah untuk nomor rekening BRIVA tersebut
amount	Numeric		Ya	Jumlah nominal untuk nomor BRIVA Note : Tidak boleh ada tanda titik (.) maupun koma (,) pada isian amount
keterangan	String		Ya	Keterangan dari nomor BRIVA
expiredDate	DateTime		Ya	Tanggal kadaluarsa untuk akun BRIVA tersebut, format: yyyy-MM-dd HH:mm:ss

Request & Response Payload Sample

Request:

          
       curl --location --request POST 'https://sandbox.partner.api.bri.co.id/v1/briva'\ 
                --header 'Content-Type: application/json' \ 
                --header 'BRI-Timestamp: 2021-07-07T08:05:09.417Z' \ 
                --header 'BRI-Signature: aNyXGyP26xxxx2be+dysMQJjJevkZua0Bjo=' \
                --header 'Authorization: Bearer xMxxlgcJtlbmOH3otgev8SXZX' \
                --data-raw '{ "institutionCode": "J104408",
                     "brivaNo": "77777", 
                     "custCode": "1255", 
                     "nama": "John Doe", 
                     "amount": "20000",
                     "keterangan": "", 
                     "expiredDate": "2019-10-29 09:57:26"
                 }'

Normal Response :

{
    "status": true,
    "responseDescription": "Success",
    "responseCode": "00",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "123456789115",
        "nama": "John Doe",
        "amount": "100000",
        "keterangan": "BRIVA Testing",
        "expiredDate": "2019-02-27 23:59:00"
    }
}

Error Response :

{
    "status": false,
    "errDesc": "Data Customer Sudah Ada",
    "responseCode": "13",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "1290055",
        "nama": "John Doe",
        "amount": "20000",
        "keterangan": "",
        "expiredDate": "2019-10-29 09:57:26"
    }
}

B. Get

Penjelasan Endpoint

Endpoint ini digunakan untuk mendapatkan informasi virtual account yang telah dibuat.

Informasi Umum

HTTP Method	GET
Path	/v1/briva/{{INSTITUTION_CODE}}/{{BRIVA_NO}}/{{CUSTOMER_CODE}}
Tipe Format	JSON
Authentication	OAuth 2.0 with Access Token

Header Structure

Key	Value	Mandatory	Length	Deskripsi
Authorization	Bearer {token}	Ya		Access Token
BRI-Timestamp		Ya		Timestamp dengan format ISO8601
BRI-Signature		Ya	64	Signature
Content-Type	application/json	Ya

Query Param Structure

Sample of HTTP request:

GET https://sandbox.partner.api.bri.co.id/v1/briva/{{INSTITUTION_CODE}}/{{BRIVA_NO}}/{{CUSTOMER_CODE}}

Field	Data Type	Max Char	Mandatory	Deskripsi
INSTITUTION_CODE	String		Ya	Institution Code ini akan diberikan oleh BRI
BRIVA_NO	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
CUSTOMER_CODE	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank

Response Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
status	bool	5	Ya	True / False
responseDescription	String		Ya	Penjelasan Respon
responseCode	String		Ya	Kode Respon
data	Array		Ya	Berisi data array untuk data respon dari BRIVA, jika kosong maka responnya adalah "Data":{}
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
nama	String	40	Ya	Nama nasabah untuk nomor rekening BRIVA tersebut
amount	Numeric		Ya	Jumlah nominal untuk nomor BRIVA Note : Tidak boleh ada tanda titik (.) maupun koma (,) pada isian amount
keterangan	String		Ya	Keterangan dari nomor BRIVA
statusBayar	String		Ya	Status pembayaran, Y berarti sudah dibayar dan N berarti belum dibayar
lastUpdate	DateTime		Ya	Update terakhir dari data VA
expiredDate	DateTime		Ya	Tanggal kadaluarsa untuk akun BRIVA tersebut, format: yyyy-MM-dd HH:mm:ss

Request & Response Payload Sample

Request:

  
    curl --location --request GET 'https://sandbox.partner.api.bri.co.id/v1/briva/J104408/77777/1290051235' \ 
    --header 'BRI-Timestamp: 2021-07-07T08:12:33.710Z' \ 
    --header 'BRI-Signature: zKxxxxvPC01UlCbN1/TXlGKMRHxWfE8Qag=' \ 
    --header 'Authorization: Bearer xMbxPT4lgcJxxxH3otgev8SXZX'

Normal Response :

{
    "status": true,
    "responseDescription": "Success",
    "responseCode": "00",
    "data": {
        "institutionCode": "J104408",
        "BrivaNo": "77777",
        "CustCode": "1290051235",
        "Nama": "John Doe",
        "Amount": "20000",
        "Keterangan": "",
        "statusBayar": "N",
        "expiredDate": "2019-10-29 09:57:26",
        "lastUpdate": null
    }
}

Error Response :

{
    "status": false,
    "errDesc": "Data Customer Tidak Ditemukan",
    "responseCode": "14",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "1255"
    }
}

C. Get Status

Penjelasan Endpoint

Semua rekening BRIVA memiliki status pembayaran. Endpoint ini digunakan untuk mendapatkan status pembayaran dari rekening BRIVA yang ada.

Informasi Umum

HTTP Method	GET
Path	/v1/briva/status/{{INSTITUTION_CODE}}/{{BRIVA_NO}}/{{CUSTOMER_CODE}}
Tipe Format	JSON
Authentication	OAuth 2.0 with Access Token

Header Structure

Key	Value	Mandatory	Length	Deskripsi
Authorization	Bearer {token}	Ya		Access Token
BRI-Timestamp		Ya		Timestamp dengan format ISO8601
BRI-Signature		Ya	64	Signature
Content-Type	application/json	Ya

Query Param Structure

Sample of HTTP request:

GET https://sandbox.partner.api.bri.co.id/v1/briva/status/{{INSTITUTION_CODE}}/{{BRIVA_NO}}/{{CUSTOMER_CODE}}

Field	Data Type	Max Char	Mandatory	Deskripsi
INSTITUTION_CODE	String		Ya	Institution Code ini akan diberikan oleh BRI
BRIVA_NO	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
CUSTOMER_CODE	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank

Response Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
status	bool	5	Ya	True / False
responseDescription	String		Ya	Penjelasan Respon
responseCode	String		Ya	Kode Respon
data	Array		Ya	Berisi data array untuk data respon dari BRIVA, jika kosong maka responnya adalah "Data":{}
statusBayar	string		Ya	Status pembayaran, Y berarti sudah dibayar dan N berarti belum dibayar

Request & Response Payload Sample

Request :


     curl --location --request GET 'https://sandbox.partner.api.bri.co.id/v1/briva/status/J104408/77777/63785523' \
          --header 'BRI-Timestamp: 2021-07-13T05:10:06.666Z' \
          --header 'BRI-Signature: O6yBbCZiXClkJ8E8shRNX7H9TZhqGiKy0PMW33+geno=' \
          --header 'Authorization: Bearer b7G5hshkiLVwXoADc9GDvn39wjPP'

Normal Response :

{
    "status": true,
    "responseDescription": "Success",
    "responseCode": "00",
    "data": {
        "statusBayar": "N"
    }
  }

Error Response :

{
    "status": false,
    "errDesc": "Gagal mendapatkan data status bayar",
    "responseCode": "21"
}

D. Update Status

Penjelasan Endpoint

Endpoint ini digunakan untuk mengelola status pembayaran rekening BRIVA yang ada.

Informasi Umum

HTTP Method	PUT
Path	/v1/briva/status
Tipe Format	JSON
Authentication	OAuth 2.0 with Access Token

Header Structure

Key	Value	Mandatory	Length	Deskripsi
Authorization	Bearer {token}	Ya		Access Token
BRI-Timestamp		Ya		Timestamp dengan format ISO8601
BRI-Signature		Ya	64	Signature
Content-Type	application/json	Ya

Request Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
statusBayar	string		Ya	Status pembayaran, Y berarti sudah dibayar dan N berarti belum dibayar

Response Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
status	bool	5	Ya	True / False
responseDescription	String		Ya	Penjelasan Respon
responseCode	String		Ya	Kode Respon
data	Array		Ya	Berisi data array untuk data respon dari BRIVA, jika kosong maka responnya adalah "Data":{}
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
statusBayar	string		Ya	Status pembayaran, Y berarti sudah dibayar dan N berarti belum dibayar

Request & Response Payload Sample

Request :


curl --location --request PUT 'https://sandbox.partner.api.bri.co.id/v1/briva/status' \
--header 'Content-Type: application/json' \
--header 'BRI-Timestamp: 2021-07-07T08:14:37.388Z' \
--header 'BRI-Signature: ESf8FyaDAuvml+6bYoWOfUyUNGGuPoe10slCAhOavrw=' \
--header 'Authorization: Bearer xMbxPT4lgcJtlbmOH3otgev8SXZX' \
--data-raw '{
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "1255",
        "statusBayar": "N"
}'

Normal Response :

{
    "status": true,
    "responseDescription": "Success",
    "responseCode": "00",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "123456789115",
        "statusBayar": "Y"
    }
}

Error Response :

{
    "status": false,
    "errDesc": "Data Customer Tidak Ditemukan",
    "responseCode": "14",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "1255",
        "statusBayar": "N"
    }
}

E. Update

Penjelasan Endpoint

Endpoint ini digunakan untuk mengupdate detail akun BRIVA yang sudah ada.

Informasi Umum

HTTP Method	PUT
Path	/v1/briva
Tipe Format	JSON
Authentication	OAuth 2.0 with Access Token

Header Structure

Key	Value	Mandatory	Length	Deskripsi
Authorization	Bearer {token}	Ya		Access Token
BRI-Timestamp		Ya		Timestamp dengan format ISO8601
BRI-Signature		Ya	64	Signature
Content-Type	application/json	Ya

Request Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
nama	String	40	Ya	Nama nasabah untuk nomor rekening BRIVA tersebut
amount	Numeric		Ya	Jumlah nominal untuk nomor BRIVA Note : Tidak boleh ada tanda titik (.) maupun koma (,) pada isian amount
keterangan	String		Ya	Keterangan dari nomor BRIVA
expiredDate	DateTime		Ya	Tanggal kadaluarsa untuk akun BRIVA tersebut, format: yyyy-MM-dd HH:mm:ss

Response Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
status	bool	5	Ya	True / False
responseDescription	String		Ya	Penjelasan Respon
responseCode	String		Ya	Kode Respon
data	Array		Ya	Berisi data array untuk data respon dari BRIVA, jika kosong maka responnya adalah "Data":{}
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
nama	String	40	Ya	Nama nasabah untuk nomor rekening BRIVA tersebut
amount	Numeric		Ya	Jumlah nominal untuk nomor BRIVA Note : Tidak boleh ada tanda titik (.) maupun koma (,) pada isian amount
keterangan	String		Ya	Keterangan dari nomor BRIVA
expiredDate	DateTime		Ya	Tanggal kadaluarsa untuk akun BRIVA tersebut, format: yyyy-MM-dd HH:mm:ss

Request & Response Payload Sample

Request :


curl --location --request PUT 'https://sandbox.partner.api.bri.co.id/v1/briva' \
--header 'Content-Type: application/json' \
--header 'BRI-Timestamp: 2021-07-07T08:15:29.391Z' \
--header 'BRI-Signature: 0YWMXx6vEKwMm4V+xxxxxUPSsDJrPKlmSffL/OK74=' \
--header 'Authorization: Bearer xMbxPT4lgxxxxxxOH3otgev8SXZX' \
--data-raw '{
  "institutionCode": "J104408",
  "brivaNo": "77777",
  "custCode": "1290051235",
  "nama": "John Doe",
  "amount": "1000000",
  "keterangan": "",
  "expiredDate": "2017-09-10 09:57:26"
}'

Normal Response :

{
    "status": true,
    "responseDescription": "Success",
    "responseCode": "00",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "123456789115",
        "nama": "John Doe",
        "amount": "1000000",
        "keterangan": "BRIVA Testing",
        "expiredDate": "2020-03-10 23:59:00"
    }
  }

Error Response :

{
    "status": false,
    "errDesc": "Data Customer Tidak Ditemukan",
    "responseCode": "14",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "12900512351",
        "nama": "John Doe",
        "amount": "1000000",
        "keterangan": "",
        "expiredDate": "2017-09-10 09:57:26"
    }
}

F. Delete

Penjelasan Endpoint

Endpoint ini digunakan untuk menghapus data BRIVA yang ada

Informasi Umum

HTTP Method	Delete
Path	/v1/briva
Tipe Format	Text/plain
Authentication	OAuth 2.0 with Access Token

Header Structure

Key	Value	Mandatory	Length	Deskripsi
Authorization	Bearer {token}	Ya		Access Token
BRI-Timestamp		Ya		Timestamp dengan format ISO8601
BRI-Signature		Ya	64	Signature
Content-Type	Text/plain	Ya

Request Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank

Response Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
status	bool	5	Ya	True / False
responseDescription	String		Ya	Penjelasan Respon
responseCode	String		Ya	Kode Respon
data	Array		Ya	Berisi data array untuk data respon dari BRIVA, jika kosong maka responnya adalah "Data":{}
institutionCode	String		Ya	Institution Code ini akan diberikan oleh BRI
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank

Request & Response Payload Sample

Request :


curl --location --request DELETE 'https://sandbox.partner.api.bri.co.id/v1/briva' \
--header 'BRI-Timestamp: 2021-07-07T08:16:08.783Z' \
--header 'BRI-Signature: U6g456rsQ3xxxxxe/AHo1Xi+17P7i8PCYv+4eav9OIE=' \
--header 'Authorization: Bearer xMbxPT4lgcJtlbmxxxxxx8SXZX' \
--header 'Content-Type: text/plain' \
--data-raw 'institutionCode=J104408&brivaNo=77777&custCode=1255'

Normal Response :

{
    "status": true,
    "responseDescription": "Success",
    "responseCode": "00",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "custCode": "1255"
    }
}

Error Response :

{
    "status": false,
    "errDesc": "Institution Code Tidak Boleh Kosong",
    "responseCode": "03",
    "data": { "{\n____\"institutionCode\":\"J104408\",\n____\"brivaNo\":\"77777\",\n____\"custCode\ ":\"\"\n}": ""
    }
}

G. Get Report

Penjelasan Endpoint

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

Informasi Umum

HTTP Method	GET
Path	/v1/briva/report/{{INSTITUTION_CODE}}/{{BRIVA_NO}}/{{START_DATE}}/ {{END_DATE}}
Tipe Format	JSON
Authentication	OAuth 2.0 with Access Token

HTTP Method

GET

Path

/v1/briva/report/{{INSTITUTION_CODE}}/{{BRIVA_NO}}/{{START_DATE}}/

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key	Value	Mandatory	Length	Deskripsi
Authorization	Bearer {token}	Ya		Access Token
BRI-Timestamp		Ya		Timestamp dengan format ISO8601
BRI-Signature		Ya	64	Signature
Content-Type	application/json	Ya

Query Param Structure

Sample of HTTP request:

GET https://sandbox.partner.api.bri.co.id/v1/briva/report_time/{{INSTITUTION_CODE}}/{{BRIVA_NO}}/{{START_DATE}}/{{END_DATE}}

Field	Data Type	Max Char	Mandatory	Deskripsi
institution_Code	String		Ya	Institution Code ini akan diberikan oleh BRI
briva_No	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
START_DATE	Date	8	Ya	Tanggal Awal, format: yyyyMMdd
END_DATE	Date	8	Ya	Tanggal Akhir, format: yyyyMMdd

Response Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
status	bool	5	Ya	True / False
responseDescription	String		Ya	Penjelasan Respon
responseCode	String		Ya	Kode Respon
data	Array		Ya	Berisi data array untuk data respon dari BRIVA, jika kosong maka responnya adalah "Data":{}
brivaNo	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
custCode	String	13	Ya	Customer code yang dibuat oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
nama	String	40	Ya	Nama nasabah untuk nomor rekening BRIVA tersebut
amount	Numeric		Ya	Jumlah nominal untuk nomor BRIVA Note : Tidak boleh ada tanda titik (.) maupun koma (,) pada isian amount
keterangan	String		Ya	Keterangan dari nomor BRIVA
paymentDate	Date	8	Ya	Waktu pembayaran, format: yyyy-MM-dd HH:MM:SS.fff
tellerid			Ya	Internal teller id BRI
no_rek			Ya	Rekening yang terdaftar di Corporate Code
startTime	Date	8	Ya	Tanggal Mulai, format: yyyy-MM-dd
endTime	Date	8	Ya	Tanggal Akhir, format: yyyy-MM-dd

Request & Response Payload Sample

Request :


curl --location --request GET 
'https://sandbox.partner.api.bri.co.id/v1/briva/report/J104408/77777/20210629/20210629' \
--header 'BRI-Timestamp: 2021-07-07T08:17:07.607Z' \
--header 'BRI-Signature: hBy3cdCLC9T7UuB5VlLgkuwJQB2zbJOE+IyKxxxxxx=' \
--header 'Authorization: Bearer xMbxPT4lgcJtlbmOHxxxxxxx8SXZX'

Normal Response :

{
    "status": true,
    "responseDescription": "Success",
    "responseCode": "00",
    "data": [
        {
            "brivaNo": "77777",
            "custCode": "2105310010",
            "nama": "John Doe",
            "keterangan": "",
            "amount": "729688",
            "paymentDate": "2021-06-29 07:41:31.000",
            "tellerid": "1624927291049",
            "no_rek": "39101000322990"
        }
    ]
}

Error Response :

{
    "status": false,
    "responseDescription": "Report briva kosong atau tidak ditemukan",
    "responseCode": "41"
}

{
    "status": false,
    "errDesc": "Format startTime atau endTime salah, harusnya Ymd",
    "responseCode": "20",
    "data": {
        "institutionCode": "J104408",
        "brivaNo": "77777",
        "startTime": "20210629",
        "endTime": "20210632"
    }
}

H. Get Report Time

Penjelasan Endpoint

Endpoint ini digunakan untuk mendapatkan history transaksi semua rekening BRIVA yang terdaftar di nomor BRIVA Anda dalam kurun waktu tertentu.

Informasi Umum

HTTP Method	GET
Path	/v1/briva/report_time/{{INSTITUTION_CODE}}/{{BRIVA_NO}} /{{START_DATE}}/{{START_TIME}}/{{END_DATE}}/{{END_TIME}}
Tipe Format	JSON
Authentication	OAuth 2.0 with Access Token

HTTP Method

GET

Path

/v1/briva/report_time/{{INSTITUTION_CODE}}/{{BRIVA_NO}}

/{{START_DATE}}/{{START_TIME}}/{{END_DATE}}/{{END_TIME}}

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key	Value	Mandatory	Length	Deskripsi
Authorization	Bearer {token}	Ya		Access Token
BRI-Timestamp		Ya		Timestamp dengan format ISO8601
BRI-Signature		Ya	64	Signature
Content-Type	application/json	Ya

Query Param Structure

Sample of HTTP request:

GET https://sandbox.partner.api.bri.co.id/v1/briva/report_time/{{INSTITUTION_CODE}}/{{BRIVA_NO}}/{{START_DATE}}/{{START_TIME}}/{{END_DATE}}/{{END_TIME}}

Field	Data Type	Max Char	Mandatory	Deskripsi
institution_Code	String		Ya	Institution Code ini akan diberikan oleh BRI
briva_No	Numeric	5	Ya	BRIVA number unik untuk institusi Anda
START_DATE	Date	8	Ya	Tanggal Awal, format: yyyy-MM-dd
START_TIME	Date	4	Ya	Waktu Mulai, format: HH:MM
END_DATE	Date	8	Ya	Tanggal Akhir, format: yyyy-MM-dd
END_TIME	Date	4	Ya	Waktu akhir, format: HH:MM

Response Structure

Field	Data Type	Max Char	Mandatory	Deskripsi
status	bool	5	Ya	True / False
responseDescription	String		Ya	Penjelasan Respon
responseCode	String		Ya	Kode Respon
data	Array		Ya	Berisi data array untuk data respon dari BRIVA, jika kosong maka responnya adalah "Data":{}
brivaNo	Numeric	5	Ya	Nomor BRIVA unik untuk institusi Anda
custCode	String	13	Ya	Customer code dihasilkan oleh Anda, kami sarankan untuk menggunakan hanya 10 digit untuk mengaktifkan pembayaran BRIVA dari bank lain karena 3 digit lainnya diperlukan untuk kode bank
nama	String	40	Ya	Nama nasabah untuk nomor rekening BRIVA tersebut
amount	Numeric		Ya	Jumlah nominal untuk rekening BRIVA Note : Tidak boleh ada tanda titik (.) maupun koma (,) pada isian amount
keterangan	String		Ya	keterangan BRIVA
paymentDate	Date	8	Ya	Waktu pembayaran, format: yyyy-MM-dd HH:MM:SS.fff
tellerid			Ya	Internal teller id BRI
no_rek			Ya	Rekening yang terdaftar pada corporate code
trxID				Transaction ID from BRI
channel				Media pembayaran untuk nomor BRIVA
startTime	Date	8	Ya	Start date, format: yyyy-MM-dd
endTime	Date	8	Ya	End date, format: yyyy-MM-dd

Request & Response Payload Sample

Request :


curl --location --request GET 'https://sandbox.partner.api.bri.co.id/v1/briva/report_time/J104408/77777/2021-06-14/05:00/2021-06-14/20:00' \
--header 'BRI-Timestamp: 2021-07-07T08:17:54.434Z' \
--header 'BRI-Signature: Q8svcZuANMo8voNxxxxxxReUiPy2Qe8=' \
--header 'Authorization: Bearer xMbxPT4lgcJtlbmOxxxxxxXZX'

Normal Response :

{
    "status": true,
    "responseDescription": "Success",
    "responseCode": "00",
    "data": [
        {
            "brivaNo": "77777",
            "custCode": "7629378614",
            "nama": "John Doe",
            "keterangan": "",
            "amount": "96140",
            "paymentDate": "2021-06-14 10:20:24.000",
            "tellerid": "1623640824274",
            "no_rek": "39101000322990",
            "trxID": "2118200000020824274",
            "channel": "IBNK"
        }
    ]
}

Error Response :

{
    "status": false,
    "responseDescription": "Report briva kosong atau tidak ditemukan",
    "responseCode": "41"
}

I. Error Codes

Kode	Deskripsi Kode
00	Success
01	No Briva Tidak Boleh Kosong
02	Customer Code Tidak Boleh Kosong
03	Institution Code Tidak Boleh Kosong
05	Institution Code Tidak Diijinkan Mengakses Nomor Briva
10	Customer Code Tidak Boleh Lebih Dari 13 Karakter
10	Nama Tidak Boleh Kosong
10	Nama Tidak Boleh Lebih Dari 40 Karakter
10	Keterangan Tidak Boleh Lebih Dari 40 Karakter
10	Status Bayar Tidak Boleh Kosong
11	Customer Code Harus Numeric
11	Amount Harus Numeric
11	Amount Tidak Boleh Kosong
11	Open payment, amount tidak boleh kosong
11	Close payment, amount tidak boleh kosong
11	Amount Harus Integer (Tidak Boleh Decimal)
12	Expired date tidak boleh lebih dari 60 month
12	Expired date tidak boleh kurang dari datetime hari ini
13	Data Customer Sudah Ada
14	Data Customer Tidak Ditemukan
15	Gagal Menyimpan Data Customer
16	Gagal Update Data Briva
17	Gagal Delete Data Briva
20	Format Expired date salah, harusnya Y-m-d H:i:s
20	Format startTime atau endTime salah, harusnya Ymd
20	Panjang startTime atau endTime salah, harusnya 8 karakter
20	Gagal update status bayar
20	Penulisan Status Bayar Salah, Harusnya Y atau N
21	Gagal mendapatkan data status bayar
41	Report briva kosong atau tidak ditemukan
42	Tanggal StartTime dan EndTime report Briva harus sama
42	Tanggal startDateTime/endDateTime Tidak Boleh Kosong

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

BRIVA

Apa itu BRIVA?

Contoh Penggunaan API BRIVA

Informasi API

Kendali Versi

Deskripsi Produk

Flow API

A. Create

Penjelasan Endpoint

Informasi Umum

Header Structure

Request Structure

Response Structure

Request & Response Payload Sample

Request & Response Payload Sample

B. Get

Penjelasan Endpoint

Informasi Umum

Header Structure

Query Param Structure

Response Structure

Request & Response Payload Sample

C. Get Status

Penjelasan Endpoint

Informasi Umum

Header Structure

Query Param Structure

Response Structure

Request & Response Payload Sample

D. Update Status

Penjelasan Endpoint

Informasi Umum

Header Structure

Request Structure

Response Structure

Request & Response Payload Sample

E. Update

Penjelasan Endpoint

Informasi Umum

Header Structure

Request Structure

Response Structure

Request & Response Payload Sample

F. Delete

Penjelasan Endpoint

Informasi Umum

Header Structure

Request Structure

Response Structure

Request & Response Payload Sample

G. Get Report

Penjelasan Endpoint

Informasi Umum

Header Structure

Query Param Structure

Response Structure

Request & Response Payload Sample

H. Get Report Time

Penjelasan Endpoint

Informasi Umum

Header Structure

Query Param Structure

Response Structure

Request & Response Payload Sample

I. Error Codes

Bagaimana Anda ingin menghubungi kami?