Bank Neo Commerce Open API Docs

1. Overview

Support merchants update the information for the existing sub-merchant or store in the BNC system.

2. API Specification

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

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 for this update process.
subjectInfo	Object
●parentMerchantId	String	M	12	Aggregator merchant or direct merchant ID which is generated by BNC.
●mId	String	M		The BNC merchant ID for information needs to be updated.
●merchantIdentity	String	M	2	1=sub-merchant 2=store
●merchantExternalMid	String	M	32	The unique id for registered merchants which is generated by merchants.
●merchantType	String	M	2	1=Enterprise 2=Individual
●merchantName	String	M	50	Full name of the registered merchants.
●provinceId	Long	M	20	Location ID provided by BNC.
●provinceName	String	M	64	Location ID provided by BNC.
●cityId	Long	M	20	Location ID provided by BNC.
●cityName	String	M	64	Location name provided by BNC.
●cityIdShort	String	M	64	Location name provided by BNC.
●districtId	Long	M	20	Location ID provided by BNC.
●districtName	String	M	64	Location name provided by BNC.
●postcodeId	Long	M	20	Location ID provided by BNC.
●merchantAddress	String	M	1024	Details address of registered merchant.
●ktpNumber	String	M	64	merchant KTP number.
●ktpCopy	String	M	512	Image_id which comes from the 「Image Upload」method.
●licenseNumber	String	O	64	Enterprise license image, mandatory once the merchant type=1(enterprise)
●licenseCopy	String	O	512	Image_id which comes from the 「Image Upload」method.
●npwpNumber	String	M	64	NPWP number
●npwpCopy	String	M	512	Image_id which comes from the 「Image Upload」method.
●nibNumber	String	O	64	NIB number.
●nibCopy	String	O	512	NIB image, mandatory once the merchant type=1(enterprise)
businessInfo	Object
●businessShortname	String	M	64	Merchant name for short.
settlementInfo	Object
●mcc	String	M	4	Merchant category code.
●terminalNumber	String	M	5	Terminal number for QRIS label.
●criteria	String	M	2	01=UMI 02=UKE 03=UME 04=UBE
●qualifications	String	O	32	/
●settlementAccountInfo	Object
●accountName	String	M	64	Merchant name of the settlement account.
●accountBank	String	M	64	Only support BNC for now.
●accountNumber	String	M	64	Settlement account number.
●contactphoneNo	String	M	32	/
●eMail	String	M	256	/
●additionInfo	Object
●certificateIncorporation	String	O	512	Deed of Incorporation, mandatory for enterprise merchants.
●certificateNo40	String	O	512	Deed of Adjustment to Law No. 40 of 2007,, mandatory for enterprise merchants.
●certificateLastAmendment	String	O	512	Last Amendment of Articles of Association,, mandatory for enterprise merchants.
●certificateDeedAmendment	String	O	512	Deed of Amendment regarding the Last Board of Directors Composition,,mandatory for enterprise merchants.
●certificateAmendmentAct	String	O	512	Amendment Act on the Arrangement of Final Shareholders, mandatory for enterprise merchants.
●certificateEstablishment	String	O	512	Validation of Establishment and Approval and/or Receipt of Notification from Menkumham, mandatory for enterprise merchants.
●sppkpCopy	String	O	512	SPPKP - Letter of Confirmation of Taxable Entrepreneur / Non-PKP Statement Letter, mandatory for enterprise merchants.
●environmentCopy	String	O	512	merchant environment image, mandatory for individual merchants.

3.2.1 Sample Request Body

{
    "applicationCode":"202301011691674101", 	// Unique generated by merchants.
    "serviceCode":"Q21",
    "subjectInfo":{
        "parentMerchantId":"000520000441",   	//Must be the store's parent merchant
        "MID":"000550000457",               	// Stores to be update
        "merchantIdentity":"2",            	   // When update store need to pass 2
        "merchantExternalMid":"ExternalMid1691669029",	// MerchantExternalMid field in Store Registration
        "merchantType":"1",
        "merchantName":"updateMerchantName",
        "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",
        "ktpNumber":"3173030108950004",
        "ktpCopy":"qris/merchant/img/UoW6KP_joZXC8hiHryJquQVHX43BMzFv27lZHwEEXUk.png",
        "licenseNumber":"24656346543645",
        "licenseCopy":"qris/merchant/img/EQ6wIDAZj_IIWkwPpWbrR2zrjpK61OorlC1_GAlHBJU.png",
        "npwpNumber":"9091",
        "npwpCopy":"qris/merchant/img/QZBNZjihXRlU8vYLhWiIhdFe3_GUHc4WWBmTIfbhICM.png",
        "nibNumber":"550000263",
        "nibCopy":"qris/merchant/img/Wix--DoN0bGXGVWfQ1O8nLAjB-LVeSnLVezymEiqi2E.png"
    },
    "businessInfo":{
        "businessShortname":"merchantName2test1"
    },
    "settlementInfo":{
        "mcc":"0763",
        "terminalNumber":"1",
        "criteria":"01",
        "qualifications":""
    },
    "settlementAccountInfo":{
        "accountName":"qiaobu",
        "accountBank":"BNC",
        "accountNumber":"5859457100781452",
        "contactName":"QIAOBU",
        "contactPhoneNo":"18038114728",
        "email":"575736427@test.com"
    },
    "additionInfo":{
        "certificateIncorporation":"qris/merchant/img/n--FHC0a9T4hiqh0sGDF3EuzDnh50ext2EAVBWy7Iu0.png",
        "certificateNo40":"qris/merchant/img/88uK-X-TKVrhggsLX0iJ3Lg-HDUXWQ6eCor3r_yueP8.png",
        "certificateLastAmendment":"qris/merchant/img/i_A4XM3ulhQozNf7HR1eZpDaILlZeLxy-plvLm4oVhM.png",
        "certificateDeedAmendment":"qris/merchant/img/Bw61S4ogVOpv62RamzzuG5Hhx5ZfjTl-vhIgwPOhQDE.pdf",
        "certificateAmendmentAct":"qris/merchant/img/Bw61S4ogVOpv62RamzzuG5Hhx5ZfjTl-vhIgwPOhQDE.pdf",
        "certificateEstablishment":"qris/merchant/img/Bw61S4ogVOpv62RamzzuG5Hhx5ZfjTl-vhIgwPOhQDE.pdf",
        "SPPKP":"qris/merchant/img/Bw61S4ogVOpv62RamzzuG5Hhx5ZfjTl-vhIgwPOhQDE.pdf",
        "environmentCopy":"qris/merchant/img/0T8U3oIoEQs5JDW83whm4I8xs5TBCxqEJMSXb0da7YU.png"
    }
}

4.1 Response Body

4.1.1 Sample 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.
mid	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.

Success:

{
    "applymentCode":"111689629760288952320",
    "additionalInfo":{ },
    "auditStatus":"1",
    "mid":"000550000457",
    "responseMessage":"Successful",
    "applicationCode":"202301011691674101",
    "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