API Docs - Account Name Validation

Buat API

API Information

Title

Account Name Validation

Version

v2.0

URL Sandbox

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

URL Production

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

Version Control

API Version

Date

Link dokumen

Description

v1.0

14 February 2022

Halaman ini

Baseline version.

v2.0

3 Juli 2024

Halaman ini

Added new version

Product Description

Product Description

Product Overview

Dokumen ini bertujuan untuk menjelaskan spesifikasi API dari pengembangan validasi rekening dan nama pemilik rekening lain metode single inkuiri yang bertujuan untuk :

  • Dokumen ini bertujuan untuk menjelaskan spesifikasi API dari pengembangan validasi rekening dan nama pemilik rekening lain metode single inkuiri yang bertujuan untuk
  • Menghimpun FBI dari jasa layanan akses per hit sukses.

Note : Tidak bisa virtual account

Endpoint

A. Account Validation

Endpoint Description

API Account Validation digunakan untuk melakukan validasi rekening dan nama pemilik bank lain

General Information

HTTP Method

POST

Path

/v1.0/validation-account/name-validate

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Mandatory

Length

Description

Example

Authorization

Bearer {token}

M

N/A

Access Token

 

BRI-Timestamp

timestamp

M

-

ISO 8601 format. Timestamp must be in UTC or GMT +0 timezone.

2021-10-08T03:42:45.379Z

BRI-Signature

signature

M

64

-

 

Content-Type

application/json

M

-

-

 

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

bankCode

String

M

 

Kode Bank

014

accountNumber

String

M

 

Nomor rekening

12345678900

additionalInfo

Object

O

 

Detail object data terdapat pada tabel dibawah ini

 

Request Structure Object "additionalInfo"

Field

Data Type

Mandatory

Length

Description

Example

deviceId

String

O

 

ID Perangkat

123456789

channel

String

O

 

Channel

mobilephone

Success Response Structure

Field

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

 

Kode Respon

0000

responseDescription

String

M

 

Keterangan Respon

Sukses

data

Object

M

 

Detail object data terdapat pada tabel dibawah ini

 

Success Response Structure Object "data"

Field

Data Type

Mandatory

Length

Description

Example

accountNo

String

M

 

Nomor Rekening

12345678900

accountName

String

M

 

Nama Pemilik Rekening

DUMMY NAME PRM

bankCode

String

M

 

Kode Bank

014

additionalInfo

Object

O

 

Detail isian object additionalInfo terdapat pada tabel dibawah ini

 

Success Response Structure Object "additionalInfo"

Field

Data Type

Mandatory

Length

Description

Example

deviceId

String

O

 

ID Perangkat

123456789

channel

String

O

 

Channel

mobilephone

Error Response Structure

Field

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

 

Kode Respon

0000

responseDescription

String

M

 

Keterangan Respon

Sukses

errorDescription

String

M

 

Keterangan Error

InqRekAsal: Message : WS_CORPORATE_CASHCARD_GEN2_CORPORATE: Corporate Tidak Ditemukan. Exception :  & InqRekTujuan: VA number not found"

data

Object

O

 

Detail object data terdapat pada tabel dibawah ini

 

Error Response Structure Object "data"

Field

Data Type

Mandatory

Length

Description

Example

additionalInfo

Object

O

 

Detail isian object additionalInfo terdapat pada tabel dibawah ini

 

Error Response Structure Object "additionalInfo"

Field

Data Type

Mandatory

Length

Description

Example

deviceId

String

O

 

ID Perangkat

123456789

channel

String

O

 

Channel

mobilephone

Request and Response Payload Sample

Request :

        {
            "bankCode":"014",
            "accountNumber":"12345678900",
            "additionalInfo":{
            "deviceId":"123456789",
            "channel":"mobilephone"
            }
        }

Normal Response :

        {
            "responseCode":"0000",
            "responseDescription":"Sukses",
            "data":{
            "accountNo":"12345678900",
            "accountName":"DUMMYNAMEPRM",
            "bankCode":"014",
            "additionalInfo":{
            "deviceId":"123456789",
            "channel":"mobilephone"
            }
            }
        }

Erorr Response :

        {
            "responseCode":"0101",
            "responseDescription":"Inquiryfailed",
            "errorDescription":"InqRekAsal:Message:WS_CORPORATE_CASHCARD_GEN2_CORPORATE:CorporateTidakDitemukan.Exception:&InqRekTujuan:VAnumbernotfound",
            "data":{
            "additionalInfo":{
            "deviceId":"123456789",
            "channel":"mobilephone"
            }
            }
        }

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Error Description

Description

200

0000

Sukses

 

Sukses

Sukses

400

0001

Gagal

empty parameter

bankCode is required, cannot be empty

 

400

0002

Gagal

validation error

bankCode is must be string type

 

400

0003

Gagal

validation error

bankCode is numerical, cannot contain letter and symbol

 

400

0004

Gagal

empty parameter

accountNumber is required, cannot be empty

 

400

0005

Gagal

validation error

accountNumber is must be string type

 

400

0006

Gagal

validation error

accountNumber is numberical only, cannot be letter or symbol

 

400

0007

Gagal

wrong content-type

Content-Type must be application/json

 

400

0008

Gagal

validation error

accountNumber must consist 15 digit of length for internal account

 

200

0102

Gagal

Inquiry timeout

Inquiry timeout

 

200

0105

Gagal

Inquiry can not be processed

AccountNumber must be in IDR

 

200

0110

Gagal

Inquiry can not be processed

Branch code/source account not found

 

200

0618

Gagal

Inquiry can not be processed

close account number

 

200

0619

Gagal

Inquiry can not be processed

Passive account number

 

200

0620

Gagal

Inquiry can not be processed

Not pool account number

 

200

0621

Gagal

Inquiry can not be processed

Dormant account number

 

200

0622

Gagal

Inquiry can not be processed

account number is VA Debit

 

200

0623

Gagal

Inquiry can not be processed

account number is Loan account

 

200

0624

Gagal

Inquiry can not be processed

account number is Deposito account