Bank Neo Commerce Open API Docs

1. Overview

Support merchants create a new direct store in the BNC system. Here this direct store allows you to register a store through the same merchant identity and settlement details with the parent merchant.

2. API Specification

Endpoint	SNAP Test Env URL: https://perf-openbanking.bankneo.co.id/open/bi/private/v1.0/qr/add-direct-merchant SNAP Prod Env URL: https://openbanking.bankneo.co.id /open/bi/private/v1.0/qr/add-direct-merchant
BNC Service Code	Q1

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
applicationCode	String	M	64	Unique request number generated by merchants system.
subjectInfo	Object
●parentMerchantId	String	M	12	Aggregator merchant or direct merchant ID which is generated by BNC.
●merchantExternalMid	String	M	32	The unique id for registered merchants which is generated by merchants.
●merchantName	String	M	50	Full name of the registered merchants.
●provinceId	Long	M	20	Location ID provided by BNC. Related with the 「4.1 Province List Request」 method.
●provinceName	String	M	64	Location ID provided by BNC. Related with the 「4.1 Province List Request」 method.
●cityId	Long	M	20	Location ID provided by BNC. Related with the 「4.2 City List Request」 method.
●cityName	String	M	64	Location name provided by BNC. Related with the 「4.2 City List Request」 method.
●cityIdShort	String	M	64	Location name provided by BNC. Related with the「 4.2 City List Request method」.
●districtId	Long	M	20	Location ID provided by BNC. Related with the 「4.3 District List Request」 method.
●districtName	String	M	64	Location name provided by BNC. Related with the 「4.3 District List Request」 method.
●postcodeId	Long	M	20	Location ID provided by BNC. Related with the「 4.4 postcode List Request」 method.
●merchantAddress	String	M	1024	Details address of registered merchants.
businessInfo	Object
●businessShortname	String	M	25	Merchant name for short.
settlementInfo	Object
●mcc	String	M	4	Merchant category code.
●terminalNumber	String	M	5	Terminal number for merchant. e.g.Could send 「10」 if the merchant has 10 terminals for their business.
●criteria	String	M	2	The criteria is normally used to define the merchant size. 01=UMI 02=UKE 03=UME 04=UBE
●environmentCopy	String	O	512	merchant environment image, mandatory for individual merchants.

3.2.1 Sample Request Body

{
"applicationCode":"081631160uniqueReq003", //It needs to be changed every time,ensure it is unique.
"businessInfo":{
    "businessShortname":"0816 testDirect00003"
},
 "subjectInfo":{
    "parentMerchantId":"000540000388",
    "merchantExternalMid":"27634726746728647267464449", //It needs to be changed every time,ensure it is unique.
    "merchantName":"0816 test00005",
    "provinceId": 1,
    "provinceName": "Daerah Khusus Ibukota Jakarta 12190",
    "cityId": 1,
    "cityIdShort": "PESISIR SELATAN",
    "cityName": "Kota Jakarta Selatan",
    "districtId": 1,
    "districtName": "Kec. Kby. Baru",
    "postcodeId": 11135,
    "merchantAddress": "Gg. Keamanan Jl. Senopati Dalam I No.12A, RT.5/RW.4, Senayan"
 },
 "settlementInfo":{
    "mcc":"1731",
    "criteria":"01",
    "terminalNumber":"100"
 },
 "additionInfo":{
    "environmentCopy":""
 }
}

4.1 Response Body

Field	Type	Mandatory	Length	Description
responseCode	String	M	7	SNAP Response code.
responseMessage	String	M	256	SNAP response message
applicationCode	String	M	64	The application code which had generated by the merchant system.
applymentCode	String	M	64	The applymentCode was generated by the BNC system and match with this registration request.
storeId	String	M	12	The registered merchant ID as pending status. What we suggest that merchants should loading the registration result inquiry for the final status update.
auditStatus	String	M	2	Indicate the current audit status. 1.AUDITING 2.SUCCESS 3.FAILED
resultCode	String	O	515	Indicate to the failure process.

4.1.1 Sample Response Body

Success:

{
    "applymentCode":"111689608487605342208",
    "additionalInfo":{

    },
    "auditStatus":"1",
    "responseMessage":"Successful",
    "storeId":"000550000457",
    "applicationCode":"202305011691669029",
    "responseCode":"200Q100"
}

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