API Services

Remittance Detail Specifications

Version 1.0
 
1. Account Info Inquiry
Hostname To be confirm
Port To be confirm
HTTP Method POST
Path /remittance/accountInfoInquiry/{Client ID}
HTTP Headers
Name Format Mandatory Description
Content-Type application/json Yes
X-API-Key String Yes API Key
Query string parameters
Name Format Mandatory Description
access_token String Yes Token provided from gettoken request
Format JSON
Authentication OAuth 2.0 (client credential)
Request Definition
Field Data Type Mandatory Description
signature String Yes Key combination : Digital Signature
accountNum String Yes Nomor rekening 3rd Party yang telah terdaftar di BNI
bankCode String Yes Customer bank code
Response Definition
Name Type Description
bankCode String Show the customer bank code
accountNumber String Customer Account Number
accountStatus String Status of Customer Account
accountName String accountName
Response (error) See Response Code

Request

{
    "bankCode": "009",
    "accountNum": " 20017330",
    "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiYW5rQ29kZSI6IjAwOSIsImFjY291bnROdW0iOiIyMDAxNzMzMCJ9.F9rutHDGQO47FFmBIl_qrGR7yMT-ZFOWJRHLauEnB8s"
}

Exp full url

https://{BNIServer}:{port}/remittance/accountInfoInquiry/{Client ID}?access_token=XUVAtlHXbjJZE69AJQXwjTzuNlYR1otNm2xLxFpcYZQiQp0Sbr5QUc

Response (Success)

{
    "accountInfoInquiryResponse": {
        "accountInfoRes": {
            "bankCode": "009",
            "accountNumber": "20017330",
            "accountStatus": "AVAILABLE",
            "accountName": "Bpk ABDUL QODIR"
        }
    }
}
 
2. Process PO
Hostname To be confirm
Port To be confirm
HTTP Method POST
Path /remittance/processPO/{Client ID}
HTTP Headers
Name Format Mandatory Description
Content-Type application/json Yes
X-API-Key String Yes API Key
Query string parameters
Name Format Mandatory Description
access_token String Yes Token provided from gettoken request
Format JSON
Authentication OAuth 2.0 (client credential)
Request Definition
Field Data Type Mandatory Description
signature String Yes Key combination : Digital Signature
serviceType String Yes Service Type BNI / CLR / RTGS / Interbank
trxDate DateTime Yes Transaction Date YYYY–MM-DDTHH:mm:ss
currency String (3) Yes Currency PO
amount Decimal (17,2) Yes Amount PO
orderingName String (35) Yes Sender Customer Name
orderingAddress1 String (35) No Sender Customer Address
orderingAddress2 String (35) No Sender Customer Address
orderingPhoneNumber String (35) No Sender Customer Phone Number
beneficiaryAccount String (35) Yes Receiver Customer Account Input Only for Credit to Account
beneficiaryAddress1 String (35) No Receiver Customer Address
beneficiaryAddress2 String (35) No Receiver Customer Address
beneficiaryPhoneNumber String (35) No Receiver Customer Phone Number
acctWithInstcode String (1) Yes Receiver Bank Code A / D
acctWithInstName String (35) Yes Receiver Bank Name acctWithInstCode = A serviceType = BNI > acctWithInstName = Receiver BIC (BNINIDJAXXX) serviceType = CLR > acctWithInstName = Clearing Code serviceType = RTGS > acctWithInstName = RTGS Code serviceType = INTERBANK > acctWithInstName = Interbank Code acctWithInstCode = D serviceType = either > acctWithInstName = Receiver Bank Name
acctWithInstAddress1 String (35) Yes Receiver Bank Address acctWithInstcode = A > acctWithInstAddress1 = blank acctWithInstcode = D > acctWithInstAddress1 = Receiver Bank Address
acctWithInstAddress2 String (35) Yes Receiver Bank Address acctWithInstcode = A > acctWithInstAddress2 = blank acctWithInstcode = D > acctWithInstAddress2 = Receiver Bank Address
acctWithInstAddress3 String (35) Yes Receiver Bank Address acctWithInstcode = A > acctWithInstAddress3 = blank acctWithInstcode = D > acctWithInstAddress3 = Receiver Bank Address
detailPayment1 String (35) No Message from Sender to Receiver
detailPayment2 String (35) No Message from Sender to Receiver
detailCharges String (3) Yes Charges Type BEN / SHA / OUR
Response Definition
Name Type Description
Messages String Confirmation Message
Response (error) See Response Code

Request

{
    "refNumber": "BNI39742356",
    "serviceType": "BNI",
    "trxDate": "2015-04-06T09:22:10.083",
    "currency": "IDR",
    "amount": "482352",
    "orderingName": "BUDDHI MAN GURUNG",
    "orderingAddress1": "dubai",
    "orderingPhoneNumber": "0122852",
    "beneficiaryAccount": "20017330",
    "beneficiaryName": "BPK 9017838915 9017838915 901783891",
    "beneficiaryAddress1": "test",
    "beneficiaryAddress2": "",
    "beneficiaryPhoneNumber": "",
    "acctWithInstcode": "A",
    "acctWithInstName": "BNINIDJAXXX",
    "acctWithInstAddress1": "",
    "acctWithInstAddress2": "",
    "acctWithInstAddress3": "",
    "detailPayment1": "Family Maintenance",
    "detailPayment2": "",
    "detailCharges": "SHA",
    "signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZWZOdW1iZXIiOiJCTkkzOTc0MjM1NiIsInNlcnZpY2VUeXBlIjoiQk5JIiwidHJ4RGF0ZSI6IjIwMTUtMDQtMDZUMDk6MjI6MTAuMDgzIiwiY3VycmVuY3kiOiJJRFIiLCJhbW91bnQiOiI0ODIzNTIiLCJvcmRlcmluZ05hbWUiOiJCVURESEkgTUFOIEdVUlVORyIsIm9yZGVyaW5nQWRkcmVzczEiOiJkdWJhaSIsIm9yZGVyaW5nUGhvbmVOdW1iZXIiOiIwMTIyODUyIiwiYmVuZWZpY2lhcnlBY2NvdW50IjoiMjAwMTczMzAiLCJiZW5lZmljaWFyeU5hbWUiOiJCUEsgOTAxNzgzODkxNSA5MDE3ODM4OTE1IDkwMTc4Mzg5MSIsImJlbmVmaWNpYXJ5QWRkcmVzczEiOiJ0ZXN0IiwiYmVuZWZpY2lhcnlBZGRyZXNzMiI6IiIsImJlbmVmaWNpYXJ5UGhvbmVOdW1iZXIiOiIiLCJhY2N0V2l0aEluc3Rjb2RlIjoiQSIsImFjY3RXaXRoSW5zdE5hbWUiOiJCTklOSURKQVhYWCIsImFjY3RXaXRoSW5zdEFkZHJlc3MxIjoiIiwiYWNjdFdpdGhJbnN0QWRkcmVzczIiOiIiLCJhY2N0V2l0aEluc3RBZGRyZXNzMyI6IiIsImRldGFpbFBheW1lbnQxIjoiRmFtaWx5IE1haW50ZW5hbmNlIiwiZGV0YWlsUGF5bWVudDIiOiIiLCJkZXRhaWxDaGFyZ2VzIjoiU0hBIn0.1pSwgLP5ETkgh7BjZuRxs4ZWinVTI8XHX-xz4JeFDyc"
}

Exp full url

https://{BNIServer}:8066/remittance/processPO/{Client ID}? access_token=4viTVUAbPBCRW0oFe5nCKLmO1ewSpU8Dwfw3Z8FLBIIQ844GP3UXbe

Response (Success)

{
    "processPOResponse": {
        "okMessage": {
            "message": "OK"
        }
    }
}
 
3. PO Info Inquiry
Hostname To be confirm
Port To be confirm
HTTP Method POST
Path /remittance/poInfoInquiry/{Client ID}
HTTP Headers
Name Format Mandatory Description
Content-Type application/json Yes
X-API-Key String Yes API Key
Query string parameters
Name Format Mandatory Description
access_token String Yes Token provided from gettoken request
Format JSON
Authentication OAuth 2.0 (client credential)
Request Definition
Field Data Type Mandatory Description
clientId String Yes BNI 3rd Part Identification
signature String Yes Key combination : Digital Signature
refNumber String (16) Yes Correspondent Reference Number
trxDate DateTime Yes Transaction Date YYYY–MM-DDTHH:mm:ss
Response Definition
Name Type Description
status String PO Status
statusDescription String PO Status Description
paymentDetail String Payment Detail
bniReference String BNI Reference Number
paidDate DateTime PO Paid Date
paidCurrrency String Paid Currency
paidAmount Decimal Paid Amount
chargesAmount Decimal chargesAmount
trxRate Decimal Paid Rate
beneficiaryAccount String Receiver Customer Account
beneficiaryName String Receiver Customer Name
beneficiaryAddress1 String Receiver Customer Address
beneficiaryAddress2 String Receiver Customer Address
paymentType String Payment Type (CRD=Transfer, CSH=Cash)
payingTellid String Payment Teller Id
Response (error) See Response Code

Request

{
    "clientId": "009",
    "refNumber": "BNI18720677",
    "trxDate": "2015-04-06T09:22:10.073",
    "signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRJZCI6IjAwOSIsInJlZk51bWJlciI6IkJOSTE4NzIwNjc3IiwidHJ4RGF0ZSI6IjIwMTUtMDQtMDZUMDk6MjI6MTAuMDczIn0.cBHTuXReGkWnkR3scQwOEXhGcdfm2XHr0zZuCFybSDA"
}

Exp full url

https://{BNIServer}:8066/remittance/poInfoInquiry/{Client ID}? access_token=4viTVUAbPBCRW0oFe5nCKLmO1ewSpU8Dwfw3Z8FLBIIQ844GP3UXbe

Response (Success)

{
    "poInfoInquiryResponse": {
        "paymentInfoList": {
            "paymentInfo": {
                "status": "RDY",
                "statusDescription": "Created",
                "paymentDetail": {
                    "bniReference": "S06ITR0004302415",
                    "beneficiaryName": "TEST",
                    "beneficiaryAddress1": "TEST"
                }
            }
        }
    }
}
 
4. Vostro Inquiry
Hostname To be confirm
Port To be confirm
HTTP Method POST
Path /remittance/vostroInquiry/{Client ID}
HTTP Headers
Name Format Mandatory Description
Content-Type application/json Yes
X-API-Key String Yes API Key
Query string parameters
Name Format Mandatory Description
access_token String Yes Token provided from gettoken request
Format JSON
Authentication OAuth 2.0 (client credential)
Request Definition
Field Data Type Mandatory Description
signature String Yes Key combination : Digital Signature
CCY String Yes Currency
Response Definition
Name Type Description
errorMessage String Error Description
accountNumber String Vostro Account Number
accountName String Vostro Account Name
currency String Vostro Account Currency
balance String Vostro Account balance
producType String Vostro Product Type
openingDate String Vostro Account Open Date
accountStatus String Vostro Account Status
Response (error) See Response Code

Request

{
    "ccy": "USD",
    "signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRJZCI6IjAwOSIsInJlZk51bWJlciI6IkJOSTE4NzIwNjc3IiwidHJ4RGF0ZSI6IjIwMTUtMDQtMDZUMDk6MjI6MTAuMDczIn0.cBHTuXReGkWnkR3scQwOEXhGcdfm2XHr0zZuCFybSDA"
}

Exp full url

https://{BNIServer}:8066/remittance/vostroInquiry/{Client ID}? access_token=4viTVUAbPBCRW0oFe5nCKLmO1ewSpU8Dwfw3Z8FLBIIQ844GP3UXbe

Response (Success)

{
    "vostroInquiryResponse": {
        "vostroRes": {
            "accountNumber": "S001060308001",
            "accountName": "OMAN UAE EXCHANGE CENTRE AND CO LLC",
            "currency": "USD",
            "balance": "8300000",
            "productType": "VOSTRO MURNI USD",
            "openingDate": "2017-03-09T00:00:00",
            "accountStatus": "BUKA"
        }
    }
}
 
5. Cancel PO
Hostname To be confirm
Port To be confirm
HTTP Method POST
Path /remittance/ cancelPO
HTTP Headers
Name Format Mandatory Description
Content-Type application/json Yes
X-API-Key String Yes API Key
Query string parameters
Name Format Mandatory Description
access_token String Yes Token provided from gettoken request
Format JSON
Authentication OAuth 2.0 (client credential)
Request Definition
Field Data Type Mandatory Description
signature String Yes Key combination : Digital Signature
currency String (3) Yes Currency PO
trxDate String Yes PO Transaction date
refNumber String Yes PO Refference Number
amount String Yes Canceled amount
Response Definition
Name Type Description
message String Indicate status of Cancel PO Request
Response (error) See Response Code

Request

{
    "amount": "8300000",
    "currency": "IDR",
    "refNumber": "S001060308001",
    "trxDate": "2017-03-09T00:00:00",
    "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhbW91bnQiOiI0ODIzNTIiLCJjdXJyZW5jeSI6IklEUiIsInJlZk51bWJlciI6IkJOSTM5NzQyMzU3IiwidHJ4RGF0ZSI6IjIwMTUtMDQtMDZUMDk6MjI6MTAuMDgzIn0.0_fL460H98rTWi4jKwZK3AId5pVbRF351lOlREMmqU"
}

Exp full url

https://{BNIServer}:8066/remittance/cancelPO/{Client ID}? access_token=4viTVUAbPBCRW0oFe5nCKLmO1ewSpU8Dwfw3Z8FLBIIQ844GP3UXbe

Response (Success)

{
    "processPOResponse": {
        "okMessage": {
            "message": "OK"
        }
    }
}

Response (error)

{
    "Fault": {
        "faultcode": "ns0:Server",
        "faultstring": "CANCEL CANNOT BE PROCESSED, PO ALREADY PAY",
        "detail": {
            "AppFault_element9": {
                "errorNumber": "IBOC301",
                "errorDescription": "CANCEL CANNOT BE PROCESSED, PO ALREADY PAY"
            }
        }
    }
}
 
6. Ammend PO
Hostname To be confirm
Port To be confirm
HTTP Method POST
Path /remittance/ammendPO/{Client ID}
HTTP Headers
Name Format Mandatory Description
Content-Type application/json Yes
X-API-Key String Yes API Key
Query string parameters
Name Format Mandatory Description
access_token String Yes Token provided from gettoken request
Format JSON
Authentication OAuth 2.0 (client credential)
Request Definition
Field Data Type Mandatory Description
signature String Yes Key combination : Digital Signature
currency String (3) Yes Currency PO
originalAccount String No Original account number for another bank
ammendAccount String No Transaction amount. (Mandatory if originalAccount is filled)
originalBenefName String No Original beneficiary name
ammendBenefName String No Ammend beneficiary name. (Mandatory if ammendBenefName is filled)
amount String Yes Amount PO
trxDate String Yes Transaction Date
Response Definition
Name Type Description
message String Indicate status of Cancel PO Request
Response (error) See Response Code

Request

{
    "refNumber": " S001060308001",
    " trxDate ": " 2017-03-09T00:00:00",
    " currency ": " IDR ",
    " amount ": " 8300000",
    " originalAccount ": " 113183203",
    " ammendAccount ": " 113183204",
    " originalBenefName ": " Sdr IRAMAX ",
    " ammendBenefName ": " PROF DUMBOLAF ",
    "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhbW91bnQiOiI0ODIzNTIiLCJjdXJyZW5jeSI6IklEUiIsInJlZk51bWJlciI6IkJOSTM5NzQyMzU3IiwidHJ4RGF0ZSI6IjIwMTUtMDQtMDZUMDk6MjI6MTAuMDgzIn0.0_fL460H98rTWi4jKwZK3AId5pVbRF351lOlREMmqU"
}

Exp full url

https://{BNIServer}:8066/remittance/ammendPO/{Client ID}? access_token=4viTVUAbPBCRW0oFe5nCKLmO1ewSpU8Dwfw3Z8FLBIIQ844GP3UXbe

Response (Success)

{
    "processPOResponse": {
        "okMessage": {
            "message": "OK"
        }
    }
}

Response (error)

{
    "Fault": {
        "faultcode": "ns0:Server",
        "faultstring": "CANCEL CANNOT BE PROCESSED, PO ALREADY PAY",
        "detail": {
            "AppFault_element9": {
                "errorNumber": "IBOC301",
                "errorDescription": "CANCEL CANNOT BE PROCESSED, PO ALREADY PAY"
            }
        }
    }
}