Bank Neo Commerce Open API Docs

1. Overview

This API allows user merchants to retrieve or check the status of the payment request previously.

2. API Specification

HTTP Method	POST
Endpoint	`/open/bi/private/v1.0/debit/status`
SNAP Service Code	55

3. Request

3.1. Request Header

	Parameter Name	Type	Length	Required	Description	Sample
1	Authorization	String	163	M	Authorization access token. Bearer type.	Bearer eyJxxxx
2	X-SIGNATURE	String	2048	M	Integrity check. Using Asymmetric-Signature mechanism to get the token, encrypted with SHA256withRSA. e.g. stringToSign = <HTTP Method> + ":" + <Service Endpoint> + ":" + toLowercase(hexEncode(SHA256(minify(<Request Body>)))) + ":" + <X-TIMESTAMP> X-SIGNATURE = SHA256withRSA(PrivateKey, stringToSign)	eTCtU8YjKpwTzvOpao1g/ZQPxKzbsbVs6iTAAECB40aWoCVptjok59uHnbQemvyn3I0FHX/kreMgXMjhs/9NXYuaz3yBzk8TJ9fyYd6DbeeqDDBpTNVaC2dNjCtIjO1xi7ZJ+DLrqz7Wqwn+PwmY+0HJrbM9al5CS/WvjqFXN5FahIRxUfW8Dt3SQ0JNN/ySkz8ari/g7ygiIaLWZf3dSpACgEANiTFfi8YbAJRlMdoRPzwRups8QBdRce8yyW+RhpiEfTeV0CfLdTBiQ7r1HVCZ3V5iU2VxkKj4lXjwbEAJJm6XeEoXugUuLsOYOa8cKQ4bZ2Nxp+xFW6zd3Yk8lA==
3	X-TIMESTAMP	String	25	M	Timestamp request. Formatted as `yyyy-MM-ddTHH:mm:ssS`	2022-09-28T13:00:00+07:00
4	X-CLIENT-KEY	String	32	M	Merchant ID. Provided by Bank.	`000580000134`
5	X-EXTERNAL-ID	String	36	M	Merchant unique request ID. Must be unique per day.
6	CHANNEL-ID	String	5	M	Bank Channel ID.	88881
7	Content-Type	String		M	Request body format type.	application/json

3.2 Request Body

Name	Type	M/O	Length	Description
originalPartnerReferenceNo	String	M	22	Merchant reference number. Should be use the `partnerReferenceNo` value from previous Payment execution.
originalReferenceNo	String	C	22	BNC transaction reference. The value retrieved from Payment response, `referenceNo` field. *This field is Conditionally. If merchant do the payment and timeout, merchant can only use the `originalPartnerReferenceNo` for check the status.
merchantId	String	M	32	Merchant ID. Provided by BNC.
subMerchantId	String	O	32	Sub Merchant ID of the Merchant. This property depends on merchant. Provided by BNC.
serviceCode	String	M	2	Service code based on BI Snap standard. 54 = Check Payment Status. 58 = Check Refund Status.

3.2.1 Sample Request Body

{
    "originalPartnerReferenceNo": "230332344123777072",
    "originalReferenceNo": "3001569502608844955649",
    "serviceCode": "54",
    "merchantId": "000580000134"
}

4. Response

4.1 Response Body

Name	Type	M/O	Length	Description
originalReferenceNo	String	M	22	BNC transaction reference.
originalPartnerReferenceNo	String	M	22	Merchant reference number.
serviceCode	String	M	2	Service code based on BI Snap standard.
latestTransactionsStatus	String	M	2	The latest transaction status.
paidTime	String	M	25	The execution time of the transaction.
transAmount	Object	M		The transaction monetary information.
-> currency	String	M	3	The transaction currency.
-> value	Double	M	14	The transaction amount.
responseMessage	String	M	200	The message corresponding to the response code.
responseCode	String	M	7	The BI Snap standard of response code.
additionalInfo	Object	M		Additional information
-> traceId	String	M	32	BNC trace ID. Used for tracing in case problem happens

4.1.1 Sample Response Body

Success:

{
    "transAmount": {
        "currency": "IDR",
        "value": 1050000.00
    },
    "additionalInfo": {
        "traceId": "6b76acdf29cde382ee5accd2a989afd6"
    },
    "originalReferenceNo": "3001569502608844955649",
    "serviceCode": "54",
    "originalPartnerReferenceNo": "230332344123777072",
    "paidTime": "2022-09-13T08:46:49+07:00",
    "responseMessage": "Successful",
    "responseCode": "2005500"
}

Fail:

{
    "additionalInfo": {
        "traceId": "6b76acdf29cde382ee5accd2a989afd6"
    },
    "responseMessage": "Transaction Not Found",
    "responseCode": "4045501"
}

	Error Code	Error Message	Description
1	4045501	Transaction Not Found	The transaction is not found.

6. Reference

	Field Code	Field Name	Description
1	M	Mandatory	Mandatory
2	ME	Mandatory Equal	Mandatory Equal – value in the request and the response must be the same.
3	C	Conditional	Conditional
4	CE	Conditional Equal	Conditional Equal – value in the request and the response must be the same.
5	O	Optional	Optional