API Account Inquiry Internal & Intrabank Transfer

Buat API

Informasi API

Title

API Account Inquiry/Intrabank Transfer

Version

v1.0

URL Sandbox

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

URL Production

  

Kendali Versi

Versi API

Tanggal

Tautan dokumen

Deskripsi

v1.0

7 Desember

Halaman ini.

Baseline version

v2.0

8 April 2022

Halaman ini

Update Format Field

v2.1

19 September 2022

Halaman ini

Update RC & example Field

Deksripsi Produk

Gambaran Produk

Fitur ini digunakan untuk pemindahbukuan dana yang bersumber dari PJP PIAS melalui layanan transfer kredit di Bank PJP AIS menggunakan API transfer intrabank

Header

Key

Value

Format

Mandatory

Length

Deskripsi

Authorization

Bearer {Token}

String

M

 

Bearer {Token}

X-TIMESTAMP

timestamp

Datetime

M

 

Format Timestamp ISO8601

X-SIGNATURE

signature

String

M

 

SHA256-HMAC

Content-type

application/json

 

M

 

application/json

X-PARTNER-ID

 

Alphanumeric

M

36

 

CHANNEL-ID

 

Alphanumeric

M

5

 

X-EXTERNAL-ID

 

Numeric

M

36

 

Endpoint

A. Internal Account Inquiry

endpoint ini digunakan untuk memvalidasi nomor dan nama rekening tujuan sebelum melakukan pemindahbukuan intrabank

General Information

HTTP Method

POST

Path

/intrabank/snap/v1.0/account-inquiry-internal

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Request Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

beneficiaryAccountNo

String

Numeric

M

15

Note : SNAP BI

length (34)

Nomor akun penerima

88880100

0157508

additionalInfo

Object

 

O

 

 

 

>deviceId

String

Alphanumeric

O

 

 

 

>channel

String

Alphanumeric

O

 

 

 

Response Structure & Sample

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

 

String

Numeric

M

7

ResponseCode

2001500

responseMessage

 

String

Alphanumeric

M

150

responseMessage

Successful

referenceNo

String

Numeric

O

Note :

SNAP BI

(C)

7

Note : SNAP BI

length (64)

Identifikasi transaksi pada sistem penyedia layanan. harus dilengkapi setelah transaksi berhasil

 

2021112

beneficiaryAccountName

 

String

Alphanumeric

M

100

Nama rekening penerima

John Doe

beneficiaryAccountNo

String

Numeric

M

15

Note : SNAP BI

length (34)

Nomor rekening penerima

888801000

157508

beneficiaryAccountStatus

 

String

Alphanumeric

O

16

Status akun penerima

Rekening Aktif

beneficiaryAccountType

String

Alphanumeric

O

1

Jenis rekening penerima

"D" untuk rekening giro

"S" untuk rekening

tabungan

S

currency

String

Alphanumeric

O

3

Mata uang

IDR

additionalInfo

 

Object

 

O

 

 

 

>channel

String

Alphanumeric

O

 

 

mobilephone

>deviceId

String

Alphanumeric

O

 

 

12345679237

Request & Response Payload Sample

Request :

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

Normal Response :

   {
           "responseCode": "2001500",
           "responseMessage": "Successful",
           "referenceNo": "2021112",
           "beneficiaryAccountNo": "888801000157508",
           "beneficiaryAccountName": "John Doe",
           "beneficiaryAccountStatus": "Rekening Aktif",
           "beneficiaryAccountType": "S",
           "currency": "IDR",
           "additionalInfo": {
                  "channel": "mobilephone",
                  "deviceId": "12345679237"
           }
      }

Error Response :

	{
		"responseCode": "4001502",
		"responseMessage": "Invalid Mandatory Field beneficiaryAccountNo"
	}

List of Error/Response Code

HTTP Status

Service Code

Code

Status

Response Description

Deskripsi

200

15

00

Sukses

Successful

  

400

15

01

Gagal

Invalid Field Format

  

400

15

02

Gagal

Invalid Mandatory Field

  

403

15

09

Gagal

Domant Account

  

403

15

18

Gagal

Inactive Card/Account/Customer

  

404

15

11

Gagal

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

  

500

15

00

Pending

General Erorr

  

504

15

00

Pending

Timeout

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

B. Transfer Intrabank

Endpoint ini digunakan untuk melakukan pemindahbukuan dana dari rekening Non-PJP Pengguna Layanan, PJP PIAS, atau PJP AIS Lembaga Selain Bank ke rekening tujuan pada satu PJP AIS Bank.

General Information

HTTP Method

POST

Path

/intrabank/snap/v1.0/transfer-intrabank

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Request Structure

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

partnerReferenceNo

String

Alphanumeric

M

20 

Note: SNAP BI

Length (64)

Identifikasi transaksi pada sistem layanan konsumen

20201029000

000000000

amount

Object

 

O

 

 

 

>value

String (ISO4 217)

Numeric

M

15,2

Note: SNAP BI

Length (16,2)

Jumlah bersih transaksi. Jika rupiah maka nilainya termasuk 2 angka desimal. misalnya Rp 10.000, akan menjadi 10000.00

10000.00

>currency

String

Alphanumeric

M

3

Mata uang

IDR

beneficiaryAccountNo

String

Numeric

M

15

Note : SNAP BI

Length (34)

Rekening penerima

88880100015

7508

customerReference

String

Alphanumeric

M

Note :

SNAP BI

(O)

20

Note : SNAP BI

Length (30)

Nomor referensi / No Referral / ID transaksi

10052020

feeType

String

Alphanumeric

M

Note :

SNAP BI

(O)

25

Kepada yang dikenai biaya

  1. OUR : biaya dibebankan ke pengirim (Default)

  2. BEN : biaya dibebankan pada penerima

  3. SHA|1000 : biaya dibagi antara pengirim dan penerima, dimana pengirim dikenakan biaya Rp 1.0000,00 dan penerima akan dikenakan biaya selebihnya

BEN

remark

String

Alphanumeric

M

Note :

SNAP BI

(O)

40

Note : SNAP BI

Length (50)

transaksi

remark test

sourceAccountNo

String

Numeric

M

15

Note : SNAP BI

Length (19)

Nomor akun sumber

88880100015

7520

transactionDate

String

Datetime

M

25

tangal transaksi : ISO 8601

2021-11-

30T10:30:

24+07:00

additionalInfo

Object

 

O

 

Informasi tambahan

 

>deviceId

String

Alphanumeric

O

 

 

12345679237

>channel

String

Alphanumeric

O

 

 

mobilephone

Response Structure & Sample

Field

Data type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Response code

2001700

responseMessage

String

Alphanumeric

M

150

Response deskripsi

Successful

referenceNo

String

Numeric

O

Note :

SNAP BI

(C)

14

Note : SNAP BI

Length (64)

Identifikasi transaksi pada sistem penyedia layanan. harus dilengkapi setelah transaksi berhasil

20211206

000000

partnerReferenceNo

String

Alphanumeric

O

20

Note : SNAP BI

Length (64)

Identifikasi transaksi pada sistem layanan konsumen

20201029000

000000000

amount

Object

 

O

 

 

 

>value

String (ISO4217)

Decimal

M

15,2

Note : SNAP BI

Length (16,2)

Jumlah bersih transaksi. Jika rupiah maka nilainya termasuk 2 angka desimal. misalnya Rp 10.000, akan menjadi 10000.00

10000.00

>currency

String

Alphanumeric

M

3

Mata uang

IDR

beneficiaryAccountNo

String

Numeric

M

15

Note : SNAP BI

Length (34)

Nomor rekening penerima

8888010001575

08

customerReference

String

Alphanumeric

O

20

Note : SNAP BI

Length (30)

No referensi / No Referral

10052020

sourceAccountNo

String

Numeric

O

15

Note : SNAP BI

Length (19)

Nomor akun sumber

8888010001575

20

transactionDate

String

Datetime

M

25

tanggal transaksi : ISO 8601

2021-11-30T10:

30:24+07:00

additionalInfo

Object

 

O

 

Informasi tambahan

 

>deviceId

String

Alphanumeric

O

 

 

12345679237

>channel

String

Alphanumeric

O

 

 

mobilephone

Request & Response Payload Sample

Request :

	  {
           "partnerReferenceNo": "2021113000000000000",
               "amount": {
               "value": "100000.00",
               "currency": "IDR"
             },
          "beneficiaryAccountNo": "888801000157508",
          "customerReference": "10052020",
          "feeType": "BEN",
          "remark": "remark test",
          "sourceAccountNo": "888801000157520",
          "transactionDate": "2021-11-30T10:30:24+07:00",
          "additionalInfo": {
                 "deviceId": "12345679237",
                 "channel": "mobilephone"
         }
      }

Normal Response :

   { 
"responseCode": "2001700", 
"responseMessage": "Successful", 
"referenceNo": "20211206000000", 
"partnerReferenceNo": "2021113000000000000", 
"amount":{ 
   "currency": "IDR",
   "value": "100000.00" 
}, 
"beneficiaryAccountNo": "888801000157508", 
"customerReference": "10052020", 
"sourceAccountNo": "888801000157520", 
"transactionDate": "2021-11-30T10:30:24+07:00", 
"additionalInfo": { 
   "channel": "mobilephone", 
   "deviceId": "12345679237" 
 }
}

Error Response :

	{
		"responseCode": "4001701",
		"responseMessage": "Invalid Field Format transactionDate"
	}

List of Error/Response Code

HTTP Status

Service Code

Code

Status

Response Description

Deskripsi

200

17

00

Sukses

Successful

 

 

400

 

17

 

01

 

Gagal

Invalid Field Format

{fieldName}

 

 

400

 

17

 

02

 

Gagal

Invalid Mandatory Field

{fieldName}

 

401

17

00

Gagal

Unauthorized.

Client

 

 

403

 

17

 

02

 

Gagal

Exceeds Transaction

Amount Limit

 

403

17

09

Gagal

Dormant Account

 

403

17

14

Gagal

Insufficient Funds

 

 

403

 

17

 

15

 

Gagal

Transaction Not Permitted.

[reason]

 

403

17

16

Pending

Suspend

Transaction

 

 

403

 

17

 

18

 

Gagal

Inactive Card/Account

/Customer

 

 

404

 

17

 

11

 

Gagal

Invalid Card/Account

/Customer [Info]/Virtual

Account

 

404

17

13

Gagal

Invalid

Amount

 

409

17

00

Gagal

Conflict

 

 

409

 

17

 

01

 

Gagal

Duplicate partnerRefere

nceNo

 

500

17

00

Pending

General Error

 

504

17

00

Pending

Timeout

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