Bank Neo Commerce Open API Docs

1. Overview

Support with the refund initiated by partner services.

2. API Specification

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

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 client system. Only available for dynamic code scenarios.
originalReferenceNo	String	O	32	Original transaction identifier on BNC system
originalExternalId	String	O	50	Original External-ID on header message
partnerRefundNo	String	M	50	Reference number from clientretirevalNumber
refundAmount	String	O
value	String	M	10	Net amount of the refund
currency	String	M	3	/
reason	String	O	256	Refund reason
additionalInfo	String	O		/
deviceId	String	O		/
channel	String	O		/

3.2.1 Sample Request Body

{
    "additionalInfo":{
        "channel":"",
        "deviceId":""
    },
    "externalStoreId":"",
    "merchantId":"",
    "originalPartnerReferenceNo":"",
    "originalExternalId":"",
    "originalReferenceNo":"2023072115548417896116252",//The value of the MPM Code Generation  Response Body : referenceNo
    "partnerRefundNo":"OY!_202307211689928187", // Transaction identifier on client system (unique)

    "reason":"",
    "refundAmount":{
        "currency":"",
        "value":"1000"
    },
    "subMerchantId":""
}

4.1 Response Body

Field	Type	Mandatory	Length	Description
responseCode	String	M	7	SNAP Response code.
responseMessage	String	M	256	SNAP response message
originalPartnerReferencerNo	String	O	50	Original transaction identifier on client system
originalExternalId	String	O	32	Original External-ID on header message
referenceNo	String	M	32	Reference number
partnerRefundNo	String	O	32	Reference number from BNC system
refundAmount	String	O
value	String	M	10	Net amount of the refund
currency	String	M	3	Currency
refundTime	String	M	20	Refund time
additionalInfo	String	O		/
deviceId	String	O		/
channel	String	O		/

4.1.1 Sample Response Body

Success:

{
    "originalReferenceNo":"2023072115548417896116252",
    "referenceNo":"2023072115903492868116253",
    "originalExternalId":"",
    "refundTime":"2023-07-21T15:29:47+07:00",
    "additionalInfo":{
        "traceId":"8373480e2ac2b5c7738e64e7348fee56",
        "channel":"",
        "deviceId":""
    },
    "originalPartnerReferenceNo":"",
    "responseMessage":"Successful",
    "partnerRefundNo":"OY!_202307211689928187",
    "responseCode":"2007800",
    "refundAmount":{
        "currency":"IDR",
        "value":"1000"
    }
}

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