Bank Neo Commerce Open API Docs

1. Overview

Support with the city list inquiry through the province ID for registration scenario

2. API Specification

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

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	M/O	Length	Description
provinceId	String	M	20	Request from the 4.1 Province List Request method

3.2.1 Sample Request Body

{
    "provinceId":"6"
}

4. Response

4.1 Response Body

Field	Type	M/O	Length	Description
responseCode	String	M	7	BNC response code
responseMessage	String	M	256	BNC response message
cityList	Object	M
● cityId	String	M	20	Used for the district list inquiry
● cityName	String	M	64	Name of the city
● cityName_short	String	M	64	Name of the city as abbreviation

4.1.1 Sample Response Body

Success:

{
    "additionalInfo": {},
    "cityList": [
        {
            "cityName": "LIMA PULUH KOTO / KOTA",
            "cityNameShort": "LIMA PULUH KOTA",
            "cityId": 13
        },
        {
            "cityName": "KEPULAUAN MENTAWAI",
            "cityNameShort": "KEP MENTAWAI",
            "cityId": 27
        },
        {
            "cityName": "PESISIR SELATAN",
            "cityNameShort": "PESISIR SELATAN",
            "cityId": 70
        },
        {
            "cityName": "PASAMAN BARAT",
            "cityNameShort": "PASAMAN BARAT",
            "cityId": 108
        },
        {
            "cityName": "SOLOK SELATAN",
            "cityNameShort": "SOLOK SELATAN",
            "cityId": 109
        },
        {
            "cityName": "BUKITTINGGI",
            "cityNameShort": "BUKITTINGGI",
            "cityId": 163
        },
        {
            "cityName": "TANAH DATAR",
            "cityNameShort": "TANAH DATAR",
            "cityId": 164
        },
        {
            "cityName": "SAWAH LUNTO",
            "cityNameShort": "SAWAH LUNTO",
            "cityId": 165
        },
        {
            "cityName": "DHARMASRAYA",
            "cityNameShort": "DHARMASRAYA",
            "cityId": 166
        },
        {
            "cityName": "PAYAKUMBUH",
            "cityNameShort": "PAYAKUMBUH",
            "cityId": 203
        },
        {
            "cityName": "PARIAMAN",
            "cityNameShort": "PARIAMAN",
            "cityId": 270
        },
        {
            "cityName": "PASAMAN",
            "cityNameShort": "PASAMAN",
            "cityId": 321
        },
        {
            "cityName": "SOLOK",
            "cityNameShort": "SOLOK",
            "cityId": 430
        },
        {
            "cityName": "AGAM",
            "cityNameShort": "AGAM",
            "cityId": 461
        }
    ],
    "responseMessage": "Successful",
    "responseCode": "200Q500" }

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