APIDOCS Balance Inquiry SNAP BI

Create API

API Information

Title

API Balance Inquiry

Version

v1.0

URL Sandbox

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

URL Production

  

Version Control

Doc Version

API Version

Date

Document Link

Description

v1.0

v1.0

7 December

This Pages

Baseline version

v2.0

v1.0

22 April 2022

This Pages

Update field format

v3.0

v1.0

29 January 2024

This Pages

Penyesuaian Isi Request dan Response Sample

Product Description

Product Overview

This feature is used to access the latest balance information from the accounts held in real time, in accordance with the services provided by PJP AIS.

 

Endpoint

API Balance Inquiry

This endpoint is used to access the latest balance information from the accounts held in real time

General Information

HTTP Method

POST

Path

/snap/v1.0/balance-inquiry

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure & Sample

Key

Value

Format

Mandatory

Length

Description

Authorization

Authorization

String

M

 

Bearer {Token}

X-TIMESTAMP

BRI - Timestamp

Datetime

M

 

Format Timestamp ISO8601

X-SIGNATURE

BRI - Signature

String

M

 

HMAC_SHA512

Content-type

application/json

 

M

 

application/json

X-PARTNER-ID

 

Alphanumeric

M

36

 

CHANNEL-ID

 

Alphanumeric

M

5

 

X-EXTERNAL-ID

 

Numeric

M

9

unique numeric for API request

Request Structure

Field

Data Type

Format

Mandatory

Length

Description

Example

accountNo

String

Numeric

M

Note: SNAP BI (C)

15

Note: SNAP BI (16)

Registered account number

1231271284141

Response Structure & Sample

Field

Data Type

Format

Mandatory

Length

Description

Example

responseCode

String

Numeric

M

7

Response code

2001100

responseMessage

String

Alphanumeric

M

150

Response description

Successful

accountNo

String

Numeric

O

15

Note : SNAP BI

Length (32)

Registered account number

115471119

name

String

Alphanumeric

O

140

Customer account name

JONOMADE

accountInfos

Array

 

O

 

 

 

>holdAmount

Object

 

O

 

 

 

>>value

String

Decimal

M

15,2

Note : SNAP BI

Length (16,2)

Hold amount that cannot be used.

If it’s IDR then value includes 2 decimal digits.

e.g. IDR 20.000,- will be placed with 20000.00 

20000.00

>>currency

String

Alphanumeric

M

3

Currency

IDR

>availableBalance

Object

 

O

 

 

 

>>value

String

Decimal

M

15,2

Note : SNAP BI

Length (16,2)

Account balance that can be used for financial transaction

130000.00

>>currency

String

Alphanumeric

M

3

Currency

IDR

>ledgerBalance

Object

 

O

 

 

 

>>value

String

Decimal

M

15,2

Note : SNAP BI

Length (16,2)

Account balance that can be used for financial transaction

30000.00

>>currency

String

Alphanumeric

M

3

Currency

IDR

>status

String

Numeric

O

4

1 = Active = Account can still be used

2 = Inactive/Closed = Account Can't be used 3 = Matured but not Closed

4 = New today = The account has just been activated (the new account was

created on the D day, not yet through the EOD process) 5 = Zero Accrual

6 = Restricted / (Frozen with Accrual) = Account can receive funds but cannot issue funds (can only be credited)

8 = Write off

7 = Frozen = Account cannot send and receive funds 

9 = Dormant = The account has not been used for a long time but can still be

activated

0004

additionalInfo

Object

 

O

 

Additional information

 

>productCode

String

Alphanumeric

O

 

 

TV

>accountType

String

Alphanumeric

O

 

S:Saving

T:Deposite

D:Giro

L:Loan

SA

Request & Response Payload Sample

Request  :

{
  "accountNo": "111231271284153"
}

Normal Response :

{
  "responseCode": "2001100",
  "responseMessage": "Successful",
  "accountNo": "111231271284153",
  "name": "JONOMADE",
  "accountInfos": [
    {
      "holdAmount": {
        "value": "20000.00",
        "currency": "IDR"
      },
      "availableBalance": {
        "value": "130000.00",
        "currency": "IDR"
      },
      "ledgerBalance": {
        "value": "30000.00",
        "currency": "IDR"
      },
      "status": "0005"
    }
  ],
  "additionalInfo": {
    "productCode": "TV",
    "accountType": "SA"
  }
}

Error Response :

{
		"ResponseCode": "4091100",
		"ResponseMessage": "Conflict"
	}

List of Error/Response Code

HTTP Status

Service Code

Code

Status

Response Message

Description

200

11

00

Success

Successful

  

400

11

01

Failed

Invalid Field Format {fieldName}

  

400

11

02

Failed

Invalid Mandatory Field {fieldName}

  

401

11

00

Failed

Unauthorized. Client

  

404

11

11

Failed

Invalid Card/Account/Customer[info]/VirtualAccount

  

409

11

00

Failed

Conflict

  

500

11

00

Failed

General Error

  

504

11

00

Pending

Timeout

  
Any error response not listed in the BRIAPI response list is considered pending and requires further investigation.