API Trigger Transfer/RTGS Transfer

Buat API

Informasi API

Judul

API Transfer RTGS

Versi

v1.0

URL Sandbox

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

URL Production

  

Kendali Versi

Versi Dok

Versi API

Tanggal

Tautan Dokumen

Deskripsi

v1.0

v1.0

1 Desember

Halaman ini.

Baseline version

v2.0

v1.0

12 April 2022

Halaman ini.

Update Field Format

Deskripsi Product

Gambaran produk

Fitur ini digunakan untuk melakukan pemindahbukuan dana dari satu rekening Non-PJP Pengguna Layanan, PJP PIAS, atau PJP AIS Lembaga Selain Bank, pada PJP AIS Bank ke rekening tujuan pada PJP AIS Bank lain melalui perantaraan Penyelenggara Infrastruktur Pembayaran (PIP) BI-RTGS.

Endpoint

A. API Trigger Transfer /RTGS Transfer

General Information

HTTP Method

POST

Path

/snap/v1.0/transfer - rtgs

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header

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

Deskripsi

Contoh

partner

Reference

No

String

Alphanumeric

M

64

Identifikasi transaksi pada sistem layanan konsumen

0201029

0000000

0000001

amount

Object

 

O

 

 

 

>value

String

Decimal

M

15,2

Note : Length SNAP BI

(16,2)

Jumlah bersih dari transaksi. Jika itu Rupiah maka nilainya termasuk 2 angka desimal, contoh Rp 10.000, akan ditempatkan dengan 10000.00

101000

000.00

>currency

String

Alphanumeric

M

3

Mata uang transaksi

IDR

beneficiary Account Name

String

Alphanumeric

M

100

Nama rekening penerima

John Doe

beneficiary

Account

No

String

Numeric

M

34

Nomor rekening penerima

88880100

0157508

beneficiary

Address

String

Alphanumeric

M

Note : SNAP BI (O)

100

Alamat penerima

Palembang

beneficiary

BankCode

 

String

Alphanumeric

M

8

Kode Bank penerima

CENAIDJA

beneficiary

BankName

String

Alphanumeric

O

50

Nama Bank penerima

Bank BRI

beneficiary

Customer

Residence

String

Numeric

M

1

Status Kewarganegaraan penerima :

1. Indonesia

2. Non Indonesia

1

beneficiary

CustotmerType

String

Numeric

M

1

Jenis nasabah penerima :

1. Perorangan

2. Perusahaan

3. Government

 1

 

customer

Reference

String

Alphanumeric

M

20

Note : Length

SNAP BI (30)

Nomor referensi / No Referral / Transaksi ID

10052019

feeType

String

Alphanumeric

M

Note : SNAP BI (O)

25

Jenis penanggung biaya (BEN=biaya ditanggung penerima, OUR=ditanggung pengirim, SHA=sharing)

BEN

kodepos

String

Numeric

O

10

Kode post pengirim

12250

receiverPhone

String

Numeric

O

20

Nomor hp/telepon penerima

089912345678

remark

String

Alphanumeric

M

Note : SNAP BI (O)

40

Note : Length

SNAP BI (50)

Keterangan/deskripsi transaksi

remark

test

sender

Customer

Residence

String

Numeric

M

Note : SNAP BI (O)

1

Status Kewarganegaraan pengirim :

  1. Indonesia

  2. Non Indonesia

1

sender

Customer

Type

String

Numeric

M

Note : SNAP BI (O)

1

Jenis nasabah pengirim :

  1. Perorangan

  2. Perusahaan

  3. Pemerintah

1

senderPhone

String

Numeric

O

20

Nomor hp/telepon pengirim

6289912345678

source

Account

No

String

Numeric

M

15

Note : Length

SNAP BI (19)

Nomor akun pengirim

88880100

0157508

transaction

Date

String

Datetime

M

25

Tanggal dan jam transaksi :

 

ISO 8601

2021-12-

30T10:38:00-

07:00

additional

Info

Object

 

M

Note : SNAP BI (O)

 

Informasi tambahan

 

>deviceId

String

Alphanumeric

O

 

 

234567

9237

>channel

String

Alphanumeric

O

 

 

mobile

phone

>sender

Name

String

Alphanumeric

M

100

Nama pengirim

Jane Doe

>sender

Identity

String

Numeric

M

16

Nomor Identitas

5221123456789101

>sender

Address

String

Alphanumeric

M

150

Alamat pengirim

Jakarta

Selatan

>corporate

Type

String

Numeric

M

1

Jenis bisnis diantaranya

  1. conventional

  2. syariah

1

Response Structure & Sample

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Response code

2002200

responseMessage

String

Alphanumeric

M

150

Deskripsi response message

Successful

referenceNo

String

Numeric

O

Note :

SNAP BI

(C)

7

Note : Length

SNAP BI (64)

Identifikasi transaksi pada sistem penyedia layanan. Harus diisi setelah transaksi berhasil

044895031692667

4532243

amount

Object

 

 O

 

  

 

 

>value

String

Decimal

M

15,2

Note :

Length

SNAP BI

(16,2)

Jumlah bersih dari transaksi. Jika itu Rupiah maka nilainya termasuk 2

angka desimal, contoh Rp 10.000, akan ditempatkan dengan 10000.00

101000000.00

>currency

String

Alphanumeric

M

3

Mata uang transaksi

IDR

beneficiaryAccountName

String

Alphanumeric

M

100

Nama rekening penerima

John Doe

beneficiaryAccountNo

String

Numeric

M

34

Nomor rekening penerima

888801000157508

beneficiaryBankCode

String

Alphanumeric

O

8

Kode Bank penerima

CENAIDJA

customerReference

String

Alphanueric

M

20

Nomer referensi / No Referral / Transaksi ID

10052019

sourceAccountNo

String

Numeric

M

15

Note :

Length

SNAP BI (19)

Kode bank penerima

88880100 0157508

transactionDate

String

Datetime

M

25

Tanggal transaksi : dd-MM-yyyy (Mandatory) HH:mm:ss (Optional)

2021-12-

30T10:38:00-07:00

00

transactionStatus

String

Numeric

M

2

00 - Success

01 - Initiated

03 - Pending

06 - Failed

 

transactionStatusDesc

String

Alphanumeric

O

50

Deskripsi status transaksi

success

additionalInfo

Object

 

M

Note :

SNAP BI

(O)

 

Informasi tambahan

 

>deviceId

String

Alphanumeric

O

 

 

12345679237

>channel

String

Alphanumeric

O

 

 

mobilephone

Request & Response Payload Sample

Request:

{
"partnerReferenceNo": "2020102900000000000001",
"amount": {
"value": "101000000.00",
"currency": "IDR"
},
"beneficiaryAccountName": "John Doe",
"beneficiaryAccountNo": "888801000157508",
"beneficiaryAddress": "Palembang",
"beneficiaryBankCode": "CENAIDJA",
"beneficiaryBankName": "BRI",
"beneficiaryCustomerResidence": "1",
"beneficiaryCustomerType": "1",
"customerReference": "1005204390",
"feeType": "BEN",
"kodepos": "12250",
"receiverPhone": "089912345678",
"remark": "remark test",
"senderCustomerResidence": "1",
"senderCustomerType": "1",
"senderPhone": "6289912345678",
"sourceAccountNo": "001901000613303",
"transactionDate": "2022-01-14T19:06:56+07:00",
"additionalInfo": {
"deviceId": "12345679237",
"channel": "mobilephone",
"senderName": "Jane Doe",
"senderIdentity": "5221123456789101",
"senderAddress": "Jakarta Selatan",
"corporateType": "1"
}
}

Normal Response :

{
"responseCode": "2002200",
"responseMessage": "Successful",
"referenceNo": "7653479233967519263132",
"amount": {
"value": "101000000.00",
"currency": "IDR"
},
"beneficiaryAccountName": "John Doe",
"beneficiaryAccountNo": "888801000157508",
"beneficiaryBankCode": "CENAIDJA",
"customerReference": "1005204390",
"sourceAccountNo": "001901000613303",
"transactionDate": "2022-01-14T19:06:56+07:00",
"transactionStatus": "06",
"transactionStatusDesc": "Failed",
"additionalInfo": {
"deviceId": "12345679237",
"channel": "mobilephone",
"senderName": "Jane Doe",
"senderIdentity": "5221123456789101",
"senderAddress": "Jakarta Selatan",
"corporateType": "1"
}
}

Error Response :

{
    "responseCode": "4002202",
    "responseMessage": "Invalid Mandatory Field partnerReferenceNo"
}

List of Error/Response Code

 

HTTP Status

Service Code

Code

Status

Response Message

Deskripsi

200

22

00

Sukses

Successful

  

400

22

02

Gagal

Invalid Mandatory Field

  

400

22

01

Gagal

Invalid Field Format

  

403

22

02

Gagal

Exceeds Transaction Amount Limit

  

403

22

09

Gagal

Dormant Account

  

403

22

14

Gagal

Insufficient Funds

  

403

22

15

Gagal

Transaction Not Permitted

  

403

22

16

Pending

Suspend Transaction

  

403

22

18

Gagal

Inactive Card/Account/Customer

  

404

22

11

Gagal

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

  

404

22

13

Gagal

Invalid Amount

  

409

22

00

Gagal

Conflict

  

500

22

00

Pending

General Erorr

  

500

22

01

Pending

Unknown Error

  

504

22

00

Pending

Timeout

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