API Docs - Account Name Validation

Create 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 to document

Description

v1.0

14 February 2022

this pages

Baseline version.

v2.0

3 Juli 2024

this pages

Added new version

Product Description

Product Description

Product Overview

This document aims to explain the API specifications of the development of account validation and other account holder names single inquiry method which aims to:

  • Accommodate customer needs for validation of other bank destination accounts
  • Collect FBI from access services per successful hit.

Note : Tidak bisa virtual account

Endpoint

A. Account Validation

Endpoint Description

API Account Validation is used to validate accounts and names of other bank owners.

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

 

Bank Code

014

accountNumber

String

M

 

Account number

12345678900

additionalInfo

Object

O

 

Additional object info details are in the table below.

 

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

 

Response Code

0000

responseDescription

String

M

 

Response Description

Sukses

data

Object

M

 

Detailed data objects are in the table below

 

Success Response Structure Object "data"

Field

Data Type

Mandatory

Length

Description

Example

accountNo

String

M

 

Account number

12345678900

accountName

String

M

 

Account Owner Number

DUMMY NAME PRM

bankCode

String

M

 

Bank Code

014

additionalInfo

Object

O

 

Details of the additional Info object fields are in the table below

 

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

 

Account number

0000

responseDescription

String

M

 

Account Owner Number

Sukses

errorDescription

String

M

 

Bank Code

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

data

Object

O

 

Details of the additional Info object fields are in the table below

 

Error Response Structure Object "data"

Field

Data Type

Mandatory

Length

Description

Example

additionalInfo

Object

O

 

Details of the additional Info object fields are in the table below

 

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

Success

 

Sukses

Sukses

400

0001

Failed

empty parameter

bankCode is required, cannot be empty

 

400

0002

Failed

validation error

bankCode is must be string type

 

400

0003

Failed

validation error

bankCode is numerical, cannot contain letter and symbol

 

400

0004

Failed

empty parameter

accountNumber is required, cannot be empty

 

400

0005

Failed

validation error

accountNumber is must be string type

 

400

0006

Failed

validation error

accountNumber is numberical only, cannot be letter or symbol

 

400

0007

Failed

wrong content-type

Content-Type must be application/json

 

400

0008

Failed

validation error

accountNumber must consist 15 digit of length for internal account

 

200

0102

Failed

Inquiry timeout

Inquiry timeout

 

200

0105

Failed

Inquiry can not be processed

AccountNumber must be in IDR

 

200

0110

Failed

Inquiry can not be processed

Branch code/source account not found

 

200

0618

Failed

Inquiry can not be processed

close account number

 

200

0619

Failed

Inquiry can not be processed

Passive account number

 

200

0620

Failed

Inquiry can not be processed

Not pool account number

 

200

0621

Failed

Inquiry can not be processed

Dormant account number

 

200

0622

Failed

Inquiry can not be processed

account number is VA Debit

 

200

0623

Failed

Inquiry can not be processed

account number is Loan account

 

200

0624

Failed

Inquiry can not be processed

account number is Deposito account