Interbank Transfer

API Information

Title

API Account Inquiry/Interbank Transfer

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

12 April 2022

This Pages

Update Field Format

v2.1

v1.0

16 September 2022

This Pages

Update response code

v2.2 v1.0 29 January 2024 This Pages
  • Update Request and Response Sample in endpoint External Account Inquiry
  • Update Request and Response Sample in endpoint Transfer Interbank

Product Description

Product Overview

This feature is used for overbooking of funds sourced from PJP PIAS account via credit transfer service on PJP AIS Bank using API interbank transfer

Endpoint

A. Eksternal Account Inquiry

This endpoint is used to validate the number and name of destination account before making a interbank transfer, RTGS, or SKNBI.

General Information

HTTP Method

POST

Path

/interbank/snap/v1.0/account-inquiry-external

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Format

Mandatory

Length

Description

Authorization

Authorization

String

M

 

Bearer {Token}

X-TIMESTAMP

timestamp

Datetime

M

 

Format Timestamp ISO8601

X-SIGNATURE

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

36

 

Request Structure

Field

Data Type

Format

Mandatory

Length

Description

Example

beneficiaryAccountCode

String

Numeric

M

3

Note :

SNAP BI

length

(8)

Beneficiary Bank Code

002

beneficiaryAccountNo

String

Numeric

M

34

Beneficiary Account Number

888801000157508

additionalInfo

Object

 

O

 

 

 

>deviceId

String

Alphanumeric

O

 

 

 

>channel

String

Alphanumeric

O

 

 

 

Response Structure & Sample

Field

Data Type

Format

Mandatory

Length

Description

Example

responseCode

String

Numeric

M

7

Response code

2000000

responseMessage

String

Alphanumeric

M

150

response Message

Successful

referenceNo

String

Numeric

O

Note :

SNAP BI

(C)

20

Note:

SNAP BI

length

(64)

Transaction identifier on service provider system. Must be filled after the transaction is successfull

2020102977770000000009

beneficiaryAccountName

String

Alphanumeric

M

100

Beneficiary Account Name

Yories Yolanda

beneficiaryAccountNo

String

Numeric

M

34

BeneficiaryAccountNumber

888801000157508

beneficiaryBankCode

String

Numeric

O

3

Note:

SNAP BI length

(8)

BeneficiaryBankCode

002

currency

String

Alphanumeric

O

3

Currency

IDR

additionalInfo

Object

 

O

 

 

mobilephone

>deviceId

String

Alphanumeric

O

 

 

12345 679237

>channel

String

Alphanumeric

O

 

 

mobilephone

Request & Response Payload Sample

Request  :

{
  "beneficiaryBankCode": "002",
  "beneficiaryAccountNo": "888801000157508",
  "additionalInfo": {
    "deviceId": "12345679237",
    "channel": "mobilephone"
  }
}

Normal Response :

{
  "responseCode": "2001600",
  "responseMessage": "Successful",
  "referenceNo": "202203070000000001",
  "beneficiaryAccountName": "Dummy",
  "beneficiaryAccountNo": "888801000157508",
  "beneficiaryBankCode": "002",
  "beneficiaryBankName": "Bank BRI",
  "currency": "IDR",
  "additionalInfo": {
    "channel": "mobilephone",
    "deviceId": "12345679237"
  }
}

Error Response :

{
    "responseCode": "4001601",
    "responseMessage": "Invalid Field Format beneficiaryAccountCode"
}
				  

List of Error/Response Code

HTTP Status

Service Code

Code

Status

ResponseDescription

Description

200

16

00

Success

Successful

 

400

16

01

Failed

Invalid Field Format {fieldName}

 

400

16

02

Failed

Invalid Mandatory Field {fieldName}

 

401

16

00

Failed

Unauthorized. Client

 

403

16

15

Failed

Transaction Not Permitted. [reason]

 

403

16

16

Pending

Suspend Transaction

 

403

16

18

Failed

Inactive Card/Account/Customer

 

404

16

11

Failed

Invalid Card/Account/Customer[info]/Virtual Account

 

500

16

00

Pending

General Error

 

504

16

00

Pending

Timeout

 

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

B. Transfer Interbank

This endpoint is used to transfer fund from one account of Non-PJP Service users, PJP PIAS, or PJP AIS Institutions other than Banks, at PJP AIS Banks to the destination account at PJP AIS other banks through the intermediary of payment infrastructure provides (PIP) such as GPN or BI - FAST

General Information

HTTP Method

POST

Path

/interbank/snap/v1.0/transfer-interbank

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Format

Mandatory

Length

Deskripsi

Authorization

Authorization

String

M

 

Bearer {Token}

X-TIMESTAMP

timestamp

Datetime

M

 

Format Timestamp ISO8601

X-SIGNATURE

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

36

 

Request Structure

Field

Data Type

Format

Mandatory

Length

Description

Example

partnerReferenceNo

String

Alphanumeric

M

20

Note: SNAP

BI Length

(64)

Transaction identification on service provider system

2020102900000000000001

amount

Object

 

M

 

 

 

>value

String (ISO4 217)

Decimal

M

15,2

Note : SNAP BI

Length (18,2)

Net amount of the transaction. If it’s IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00

10000.00

>currency

String

Alphanumeric

M

3

Currency

IDR

beneficiaryAccountName

String

Alphanumeric

M

100

BeneficiaryAccountName

Yories Yolanda

beneficiaryAccountNo

String

Numeric

M

16

Note : SNAP BI

Length (34)

BeneficiaryAccount

8888010001575

08

beneficiaryAddress

String

Alphanumeric

O

100

BeneficiaryAddress

Palembang

beneficiaryBankCode

String

Numeric

M

3

Note : SNAP BI

Length (8)

BeneficiaryBankCode

002

beneficiaryBankName

String

Alphanumeric

O

50

BeneficiaryBankName

Bank BRI

beneficiaryEmail

String

Alphanumeric

O

50

BeneficiaryEmail

yories.yolanda@work.bri.co.id

customerReference

String

Alphanumeric

O

20

Note : SNAP BI

Length (30)

Reference Number / Referral Number / Transaction ID

10052022

sourceAccountNo

String

Numeric

M

15

Note : SNAP BI

Length (19)

Source Account Number

888801000157520

transactionDate

String

Datetime

M

25

transaction date : ISO 8601

2021-11-25

additionalInfo

Object

 

O

 

Additional information

 

>deviceId

String

Alphanumeric

M

 

 

1234579237

>channel

String

Alphanumeric

M

 

 

mobilephone

Response Structure & Sample

Field

Data Type

Format

Mandatory

Length

Description

Example

responseCode

String

Numeric

M

7

Response code

2001800

responseMessage

String

Alphanumeric

M

150

Response description

Successful

referenceNo

String

Numeric

O

Note :

SNAP BI

(C)

7

Note : SNAP BI

Length

(64)

Identification of transactions on the service provider system. must be filled after the transaction is successful

202112

partnerReferenceNo

String

Alphanumeric

O

64

Identification of transactions in the customer service system

2020102900000000000001

amount

Object

 

O

 

 

 

>value

String (ISO4217)

Decimal

M

15,2

Note : SNAP BI

Length (16,2)

Net amount of the transaction. If it’s IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00

10000.00

>currency

String

Alphanumeric

M

3

Currency

IDR

beneficiaryAccountNo

String

Numeric

M

34

Note : SNAP BI

Length (19)

BeneficiaryAccountNumber

888801000157508

beneficiaryBankCode

String

Numeric

O

3

Note : SNAP BI

Length

(8)

BeneficiaryBankCode

002

sourceAccountNo

String

Numeric

O

15

Note : SNAP BI

Length (19)

SourceAccountNumber

888801000157520

additionalInfo

Object

 

O

 

Additional information

 

>deviceId

String

Alphanumeric

O

 

 

12345679237

>channel

String

Alphanumeric

O

 

 

mobilephone

Request & Response Payload Sample

Request  :

{
  "partnerReferenceNo": "20211130000000001",
  "amount": {
    "value": "10000.00",
    "currency": "IDR"
  },
  "beneficiaryAccountName": "Dummy",
  "beneficiaryAccountNo": "888801000187508",
  "beneficiaryAddress": "Palembang",
  "beneficiaryBankCode": "002",
  "beneficiaryBankName": "Bank BRI",
  "beneficiaryEmail": "yories.yolanda@work.bri.co.id",
  "customerReference": "10052023",
  "sourceAccountNo": "988901000187608",
  "transactionDate": "2022-11-07T15:19:24+07:00",
  "additionalInfo": {
    "deviceId": "12345679237",
    "channel": "mobilephone"
  }
}

Normal Response :

{
  "responseCode": "2001800",
  "responseMessage": "Successful",
  "referenceNo": "202401250000000003",
  "partnerReferenceNo": "20211130000000001",
  "amount": {
    "currency": "IDR",
    "value": "10000.00"
  },
  "beneficiaryAccountNo": "888801000187508",
  "beneficiaryBankCode": "002",
  "sourceAccountNo": "988901000187608",
  "additionalInfo": {
    "channel": "mobilephone",
    "deviceId": "12345679237"
  }
} 

Error Response :

	{
		"responseCode": "4001801",
		"responseMessage": "Invalid Field Format transaction date"
	}						  

List of Error/Response Code

HTTP Status

Service Code

Code

Status

ResponseDescription

Description

200

18

00

Success

Successful

 

202

18

00

In Progress

Request In Progress

 

400

18

01

Failed

Invalid Field Format {fieldName}

 

400

18

02

Failed

Invalid Mandatory Field {fieldName}

 

401

18

00

Failed

Unauthorized. Client

 

403

18

02

Failed

Exceeds Transaction Amount Limit

 

403

18

14

Failed

Insufficient Funds

 

403

18

15

Failed

Transaction Not Permitted. [reason]

 

403

18

16

Pending

Suspend Transaction

 

403

18

18

Failed

Inactive Card/Account/Customer

 

404

18

11

Failed

Invalid Card/Account/Customer[info]/Virtual Account

 

404

18

13

Failed

Invalid Amount

 

409

18

01

Failed

Conflict

 

500

18

00

Pending

General Error

 

504

18

00

Pending

Timeout

 

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