API Trigger Transfer/SKNBI Transfer

Buat API

Informasi API

Judul

API Transfer SKNBI

Versi

v1.0

URL Sandbox

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

URL Production

 

Kendali Versi

Versi API

Tanggal

Tautan Dokumen

Deskripsi

v1.0

26 November 2021

Halaman ini.

Baseline version

v2.0

12 April 2022

Halaman ini.

Update Field Format

Deskripsi Produk

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 / SKNBI Transfer

General Information

HTTP Method

POST

Path

/snap/v1.0/transfer-sknbi

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure Request

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

partnerReference No

String

Alphanumeric

M

64

Identifikasi transaksi pada sistem layanan konsumen

20201029000

000000002

amount

Object

  

M

      

>value

String

Decimal

M

15,2

Note : Length SNAP BI

(16,2)

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

110000000.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

Rekening penerima

88880100015

7508

beneficiaryAddress

String

Alphanumeric

M

Note: SNAP BI (O)

100

Alamat penerima

Palembang

beneficiaryBankCode

String

Alphanumeric

M

8

Kode Bank penerima

CENAIDJA

beneficiaryCustomerResidence

String

Alphanumeric

M

1

Status Kewarganegaraan penerima :

1.Indonesia

2. Non Indonesia

1

beneficiaryCustomerType

String

Numeric

M

1

Jenis nasabah penerima :

  1. Perorangan

  2. Perusahaan

  3. Pemerintah

1

customerReference

String

Alphanumeric

M

20

Note : Length SNAP BI (30)

Nomor referensi / No Referral / Transaksi ID

100520193

feeType

String

Alphanumeric

M

Note : SNAP BI (O)

25

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

BEN

receiverPhone

String

Numeric

O

20

Nomor hp/telepon penerima

6289912345678

remark

String

Alphanumeric

M

40

Note : Length SNAP BI (50)

Keterangan/deskripsi transaksi

remark test

senderCustomer Residence

String

Numeric

M

Note : SNAP BI (O)

1

Status kewarganegaraan pengirim :

  1. Indonesia

  2. Non Indonesia

1

senderCustomer Type

String

Numeric

M

Note : SNAP BI (O)

1

Jenis nasabah pengirim :

  1. Perorangan

  2. Perusahaan

  3. Pemerintah

1

senderPhone

String

Numeric

O

20

Sumber telepon pelanggan

089912345678

sourceAccountNo

String

Numeric

M

15

Note : Length SNAP BI (19)

Kode Bank penerima

88880100015

7509

transactionDate

String

Datetime

M

25

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

2021-12-

30T10:38:00-

07:00

additionalInfo

Object

  

M

Note : SNAP BI (O)

  

Informasi tambahan

  

>deviceId

String

Alphanumeric

O

    

12345679237

>channel

String

Alphanumeric

O

    

mobilephone

>senderName

String

Alphanumeric

M

100

Nama Pengirim

Jane Doe

>senderIdentity

String

Numeric

M

16

Nomor identitas (NIK KTP) pengirim

5221123456789101

>senderAddress

String

Alphanumeric

M

150

Alamat Pengirim

Jakarta Selatan

>corporateType

String

Numeric

M

1

Jenis badan usaha yang bisa digunakan, meliputi :

  1. konvensional

  2. syariah

1

Response Structure & Sample

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Kode respon

2002300

responseMessage

String

Alphanumeric

M

150

Respon deskripsi

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

59924966539

7303382689

amount

Object

 

O

 

 

 

>value

String

Decimal

M

15,2

Note : Length SNAP BI

(16,2)

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

110000000.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

88880100015

7508

beneficiaryBankCode

String

Alphanumeric

O

8

Kode Bank penerima

CENAIDJA

customerReference

String

Alphanumeric

M

20

Nomer referensi / No Referral / Transaksi ID

100520193

sourceAccountNo

String

Numeric

M

15

Note : Length

SNAP BI(19)

Nomor rekening pengirim

88880100015

7509

transactionDate

String

Datetime

M

25

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

2021-12-

30T10:38:00-

07:00

transactionStatus

String

Numeric

M

2

00- Success

01- Initiated

03 - Pending

06 - Failed

06

transactionStatusDesc

String

Alphanumeric

O

50

Deskripsi status transaksi

Failed

additionalInfo

Object

 

M

Note :

SNAP BI

(O)

 

Informasi tambahan

Additional Information

>deviceId

String

Alphanumeric

O

 

 

12345679237

>channel

String

Alphanumeric

O

 

 

mobilephone

Request & Response Payload Sample

Request 


  { 
      "partnerReferenceNo": "20201029000000000002", 
      "amount": { 
        "value": "110000000.00", 
        "currency": "IDR" 
      }, 
      "beneficiaryAccountName": "John Doe", 
      "beneficiaryAccountNo": "888801000157508", 
      "beneficiaryAddress": "Palembang", 
      "beneficiaryBankCode": "CENAIDJA", 
      "beneficiaryCustomerResidence": "1", 
      "beneficiaryCustomerType": "1", 
      "customerReference": "100520193", 
      "feeType": "BEN",
      "receiverPhone": "6289912345678", 
      "remark": "remark test", 
      "senderCustomerResidence": "1", 
      "senderCustomerType": "1",
      "senderPhone": "089912345678", 
      "sourceAccountNo": "888801000157509", 
      "transactionDate": "2021-12-30T10:38:00-07:00", 
      "additionalInfo": { 
        "deviceId": "12345679237", 
        "channel": "mobilephone", 
        "senderName": "Jane Doe", 
        "senderIdentity": "5221123456789101", 
        "senderAddress": "Jakarta Selatan", 
        "corporateType": "1" 
     }   
  }'

Normal Response :

	{
        "responseCode": "2002300",
        "responseMessage": "Successful",
        "referenceNo": "3599249665397303382689",
        "amount": {
            "value": "110000000.00",
            "currency": "IDR"
        },
        "beneficiaryAccountName": "John Doe",
        "beneficiaryAccountNo": "888801000157508",
        "beneficiaryBankCode": "CENAIDJA",
        "customerReference": "100520193",
        "sourceAccountNo": "888801000157509",
        "transactionDate": "2021-12-30T10:38:00-07:00",
        "transactionStatus": "06",
        "transactionStatusDesc": "Failed",
        "additionalInfo": {
            "deviceId": "12345679237",
            "channel": "mobilephone"
        }
    }

 

Error Response :


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

List of Error/Response Code

HTTP Status

Service Code

Case Code

Status

Response Message

Deskripsi

200

23

00

Sukses

Successful

Sukses

400

23

01

Gagal

Invalid format

Format tidak valid

400

23

02

Gagal

invalid mandatory field

Format field mandatory tidak valid atau hilang

403

23

02

Gagal

Exceeds Transaction Amount Limit

  

403

23

09

Gagal

Dormant Account

  

403

23

14

Gagal

Insufficient Funds

  

403

23

15

Gagal

Transaction Not Permitted

  

403

23

16

Pending

Suspend Transaction

  

403

23

18

Gagal

Inactive Account

  

404

23

11

Gagal

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

  

404

23

13

Gagal

Invalid Amount

  

409

23

00

Gagal

Conflict

Tidak boleh menggunakan X-EXTERNAL-ID yang sudah digunakan

500

23

01

Pending

Unknown Error

  

500

23

00

Pending

General Erorr

  

504

23

00

Pending

Timeout

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