1. Overview
Support merchants create a new franchisee store in the BNC system. The franchisee store must use a different merchant identity to process the registration.
2. API Specification
Endpoint |
|
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 | / | |
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. |
●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. 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. |
●ktpNumber | String | M | 16 | merchant KTP number. |
●ktpCopy | String | M | 512 | Image_id which comes from the 「4.10 Image Upload」method. |
●licenseNumber | String | O | 64 | Enterprise license image, mandatory once the merchant type=1(enterprise) |
●licenseCopy | String | O | 256 | Image_id which comes from the 「4.10 Image Upload」method. |
●npwpNumber | String | O | 15 | NPWP number, only mandatory for the merchant type as Enterprise. |
●npwpCopy | String | O | 512 | Image_id which comes from the 「Image Upload」method, only mandatory for the merchant type as Enterprise. |
●nibNumber | String | O | 64 | NIB number. |
●nibCopy | String | O | 512 | NIB image, mandatory once the merchant type=1(enterprise) |
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 | 32 | The criteria is normally used to define the merchant size. 01=UMI 02=UKE 03=UME 04=UBE |
●qualifications | String | O | 32 | The qualification which only request for the special criteria merchant. |
●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 | Will also used for the verification case if necessary. |
●contactName | String | M | 64 | / |
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, optional for individual merchants. |
3.2.1 Sample Request Body
{ "applicationCode":"202305011691667272",// Unique generated by merchants. "merchantIdentity":"1", "serviceCode":"Q21", "subjectInfo":{ "parentMerchantId":"000570000316", //Platform Merchant "merchantExternalMid":"TestExternalMid1691667272", //Unique generated by merchants. "merchantType":"1", "merchantName":"TestMerchantName1691667272", "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":"1111111111111", "licenseCopy":"qris/merchant/img/EQ6wIDAZj_IIWkwPpWbrR2zrjpK61OorlC1_GAlHBJU.png", "npwpNumber":"22222222222222", "npwpCopy":"qris/merchant/img/QZBNZjihXRlU8vYLhWiIhdFe3_GUHc4WWBmTIfbhICM.png", "nibNumber":"33333333333333", "nibCopy":"qris/merchant/img/Wix--DoN0bGXGVWfQ1O8nLAjB-LVeSnLVezymEiqi2E.png" }, "businessInfo":{ "businessShortname":"merchantName2test1" }, "settlementInfo":{ "mcc":"0763", "terminalNumber":"1", "criteria":"01", "qualifications":"" }, "settlementAccountInfo":{ "accountName":"test", "accountBank":"BNC", "accountNumber":"5859459400068010", "contactName":"test", "contactPhoneNo":"8838114728", "email":"999999999@qq.com" }, "additionInfo":{ "certificateIncorporation":"qris/merchant/img/IpJadYAt9Lgh_l84Jab8e8OGei4YpoHHeuqUolZQYsI.pdf", "certificateNo40":"qris/merchant/img/nVJpafZbWN4LjtV-s4jIIlgBIzpbNf0a_sYh2alfpMU.xls", "certificateLastAmendment":"qris/merchant/img/IpJadYAt9Lgh_l84Jab8e8OGei4YpoHHeuqUolZQYsI.pdf", "certificateDeedAmendment":"qris/merchant/img/IpJadYAt9Lgh_l84Jab8e8OGei4YpoHHeuqUolZQYsI.pdf", "certificateAmendmentAct":"qris/merchant/img/IpJadYAt9Lgh_l84Jab8e8OGei4YpoHHeuqUolZQYsI.pdf", "certificateEstablishment":"qris/merchant/img/IpJadYAt9Lgh_l84Jab8e8OGei4YpoHHeuqUolZQYsI.pdf", "SPPKP":"qris/merchant/img/IpJadYAt9Lgh_l84Jab8e8OGei4YpoHHeuqUolZQYsI.pdf", "environmentCopy":"qris/merchant/img/njkOGkgFgBX9EHZaFK6aM-9CZ76kJBn01F7_veRggpo.jpeg" } }
4.1 Response Body
Field | Type | M/O | Length | Description |
---|---|---|---|---|
responseCode | String | M | 7 | SNAP Response code. |
responseMessage | String | M | 512 | 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. |
subMerchantId | 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:
{ "subMerchantId":"000580000456", "applymentCode":"111689601116502073344", // bnc serial number "additionalInfo":{ }, "auditStatus":"1", "responseMessage":"Successful", "applicationCode":"202305011691667272", // Merchant side serial number "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 |