API Transaction Status Inquiry

Create 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

This pages.

Baseline version

v2.0

 v1.0

12 April 2022

This pages.

Format Field Format
v3.0 v1.0 29 Jan 2024 This pages. Updated body of Request and Response Sample

 

Product Description

Product Overview

This feature is used for overbooking of funds from one account to another, both in the same or different PJP AIS initiated by the sender.

Endpoint

A. API Transaction Status Inquiry

This endpoint can be used in the event of a system interruption, time out, or other things that can affect the system lead to different interpretations of the settlement of a transaction

General Information

HTTP Method

POST

Path

/snap/v1.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)

Identify the original transaction on the customer service system

20201029000000000000

serviceCode

String

Numeric

M

2

Transaction type indicator (service code from the original transaction request)

17

transactionDate

 

String

Datetime

M

Note:

SNAP BI

(O)

25

transaction date : 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

Response Code

2003600

responseMessage

String

Alphanumeric

M

150

Response description

Successful

originalReferenceNo

String

Alphanumeric

O

Note:

SNAP BI

(C)

64

Identification of the original transaction on the service provider's system. must be filled after the transaction is successful

202112070000000001

originalPartnerReferenceNo

String

Alphanumeric

O

64

Identify the original transaction on the customer service system

20211130

00000000

000001

serviceCode

String

Numeric

M

2

Transaction type indicator (service code from the original transaction request)

18

transactionDate

String

Datetime

O

25

transactiondate : ISO8601

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)

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

Beneficiary Account

888801000157508

referenceNumber

String

Numeric

O

30

Reference Number of the system that appears when latestTransactionStatus 00 Success, otherwise the value inside becomes empty / 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.