API Inquiry Status Transaksi

Buat API

API Information

Title

API Transaction Status 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 2021

Halaman ini

Baseline version

v2.0

 v1.0

8 April 2022

Halaman ini

Update Format field
v3.0 v1.0 29 Januari 2024 Halaman ini Penyesuaian isi Request dan Normal Sample

Catatan: Layanan API ini hanya dapat dilakukan di luar periode Akhir Hari (EOD). Untuk setiap transaksi transfer yang dilakukan pada periode EOD yang menghasilkan time-out atau respons tertunda, pengecekan akun dapat dilakukan pada pukul 8 pagi Waktu Indonesia Barat.

Product Description

Deskripsi Produk

Gambaran Produk

Fitur ini digunakan untuk pemindahbukuan dana dari satu rekening ke rekening lainnya baik dalam PJP AIS yang sama maupun berbeda yang diprakarsai oleh pengirim

Endpoint

A. API Transaction Status Inquiry

Endpoint ini dapat digunakan pada saat terjadi gangguan pada sistem, time out, atau hal-hal yang dapat menyebabkan perbedaan interpretasi atau penyelesaian suatu transaksi.

General Information

HTTP Method

POST

Path

/snap/v2.0/transfer/status

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header

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

originalPartnerReferenceNo

String

Alphanumeric

M

Note:

SNAP BI

(O)

20

Note :

SNAP BI

length

(64)

Identifikasi transaksi asli pada sistem layanan konsumen

2020102 9000000 00000001

serviceCode

String

Numeric

M

2

Indikator jenis transaksi (kode layanan dari permintaan transaksi asli)

17

transactionDate

 

String

Datetime

M

Note:

SNAP BI

(O)

25

Tanggal transaksi : ISO 8601

2019-07- 03T12:08 :56- 07:00

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

Respon Code

2003600

responseMessage

String

Alphanumeric

M

150

Respon deskripsi

Successful

originalReferenceNo

String

Alphanumeric

O

Note:

SNAP BI

(C)

64

Identifikasi transaksi asli pada sistem penyedia layanan. harus diisi setelah transaksi berhasil

202112070000000001

originalPartnerReferenceNo

String

Alphanumeric

O

64

Identifikasi transaksi asli pada sistem layanan konsumen

2021113000000000000001

serviceCode

String

Numeric

M

2

Indikator jenis transaksi (kode layanan dari permintaan transaksi asli)

18

transactionDate

String

Datetime

O

25

tanggal transaksi : ISO8601
8601

2019-07-
03T12:08:
56-07:00

2021-11-30T10:30:24+07:00

amount

Object

 

O

      

>value

String

Decimal

M

15,2

Note :

SNAP BI

length

(16,2)

Jumlah bersih dari transaksi. jika itu 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

34

Rekening penerima

888801000157520

referenceNumber

String

Numeric

O

30

nomor referensi dari sistem yang muncul saat latestTransactionStatus 00 Sukses, selain itu maka value didalam menjadi kosong/ empty string

10052022

sourceAccountNo

String

numeric

M

15

Note :

SNAP BI

length

(19)

Source Account

888801000157520

latestTransactionStatus

String

Numeric

M

2

00 - Success
01 - Initiated
03 - Pending
06 - Failed

00

transactionStatusDesc

String

Alphanumeric

O

50

  

Success

additionalInfo

Object

 

O

      

>channel

String

Alphanumeric

O

    

mobilephone

>deviceId

String

Alphanumeric

O

    

12345679237

Request & Response Payload Sample

Request 

{
  "originalPartnerReferenceNo": "100520138",
  "transactionDate": "2024-01-02T17:11:05+07:00",
  "serviceCode": "18",
  "additionalInfo": {
    "deviceId": "12345679237",
    "channel": "mobilephone"
  }
}

Normal Response :

{
  "responseCode": "2003600",
  "responseMessage": "Successful",
  "originalReferenceNo": "202401020000000003",
  "originalPartnerReferenceNo": "202401021710245451",
  "serviceCode": "18",
  "transactionDate": "2024-01-02T17:11:05+07:00",
  "amount": {
    "value": "10000.00",
    "currency": "IDR"
  },
  "beneficiaryAccountNo": "888801000157626",
  "beneficiaryBankCode": "003",
  "referenceNumber": "100520138",
  "sourceAccountNo": "111231271284145",
  "latestTransactionStatus": "03",
  "transactionStatusDesc": "Pending",
  "additionalInfo": {
    "channel": "",
    "deviceId": ""
  }
}

Error Response :

      
{
    "responseCode": "4003602",
    "responseMessage": "Invalid Mandatory Field originalPartnerReferenceNo"
}

List of Error/Response Code

HTTP Status

Service Code

Code

Status

Response Message

Description

200

36

00

Success

Successful

  

401

36

00

Failed

Unauthorized. Client

  

400

36

01

Failed

Invalid Field Format {fieldName}

  

400

36

02

Failed

Invalid Mandatory Field {fieldName}

  

403

36

15

Failed

Transaction Not Permitted. [reason]

  

404

36

01

Failed

Transaction not found

  

500

36

00

Failed

General Error

  

504

36

00

Failed

Timeout

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