Bank Neo Commerce Open API Docs

1. Overview

This method allows you to invalidate the pending dynamic QR transaction. The transaction status will be turned to 「 Canceled」once QR is invalidated successfully.

2. API Specification

Endpoint	SNAP Test Env URL: https://perf-openbanking.bankneo.co.id/open/bi/private/v1.0/qr/cancel/dynamic SNAP Prod Env URL: https://openbanking.bankneo.co.id/open/bi/private/v1.0/qr/cancel/dynamic
Service Code	77

3. Request

3.1. Request Header

Name	Type	M/O	Description	Sample
Content-Type	application/json	M	Content type	application/json
Authorization	String	M	/	Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
X-TIMESTAMP	String	M	yyyy-MM-dd HH:mm:ss	2020-12-17T10:55:00+07:00
X-SIGNATURE	String	M	/	85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c8625 61b19a5
ORIGIN	String	M	/	www.hostname.com
X-PARTNER-ID	String	M	/	82150823919040624621823174737537
X-EXTERNAL-ID	String (36)	M	/	41807553358950093184162180797837
CHANNEL-ID	String	M	/	95221

3.1.1 Sample Request Header

Content-type: application/json
Authorization: Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
ORIGIN: www.hostname.com
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
CHANNEL-ID: 95221

3.2 Request Body

Field	Type	Mandatory	Length	Description
originalPartnerReferenceNo	String	O	50	Original transaction identifier on service consumer system
originalReferenceNo	String	M	32	Original transaction identifier on service provider system
reason	String	M	256	Reason for cancellation
merchantId	String	O	12	Use the MID as a unique identifier Mandatory to send this value to BNC
subMerchantId	String	O	12	Sub merchant ID Mandatory to send this value to BNC if partner have multi-merchant
externalStoreID	String	O	64	Unique shop id from merchant side Mandatory to send this value to BNC if partner have multi-store
additionalInfo	Object	O

3.2.1 Sample Request Body

{
  "originalPartnerReferenceNo": "",
  "originalReferenceNo": "2023101814012941070122319", //The value of the MPM Code Generation  Response Body : referenceNo
  "reason": "test reason"
}

4.1 Response Body

Field	Type	Mandatory	Length	Description
responseCode	String	M	7	SNAP Response code.
responseMessage	String	M	256	SNAP response message
originalPartnerReferenceNo	String	O	50	Original transaction identifier on service consumer system
originalReferenceNo	String	O	32	Original transaction identifier on service provider system
additionInfo	Object	O

4.1.1 Sample Response Body

Success:

{
    "originalReferenceNo": "2023101814012941070122319",
    "additionalInfo": {},
    "originalPartnerReferenceNo": "",
    "responseMessage": "Successful",
    "responseCode": "2007700"
}

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