Bank Neo Commerce Open API Docs

1. Overview

Support with the district list inquiry through the city 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-district SNAP Prod Env URL: https://openbanking.bankneo.co.id/open/bi/private/v1.0/qr/query-district
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
cityId	String	M	20	Request from the 4.2 City List Request method

3.2.1 Sample Request Body

{
    "cityId":"27"
}

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
districtList	Object	M
● districtId	String	M	20	Used for the postcode list inquiry
● districtName	String	M	64	Name of the district

4.1.1 Sample Response Body

Success:

{
    "districtList": [
        {
            "districtId": 288,
            "districtName": "PAGAI SELATAN"
        },
        {
            "districtId": 289,
            "districtName": "PAGAI UTARA"
        },
        {
            "districtId": 290,
            "districtName": "SIKAKAP"
        },
        {
            "districtId": 291,
            "districtName": "SIPORA SELATAN"
        },
        {
            "districtId": 292,
            "districtName": "SIPORA UTARA"
        },
        {
            "districtId": 293,
            "districtName": "SIBERUT BARAT DAYA"
        },
        {
            "districtId": 294,
            "districtName": "SIBERUT SELATAN"
        },
        {
            "districtId": 295,
            "districtName": "SIBERUT TENGAH"
        },
        {
            "districtId": 296,
            "districtName": "SIBERUT BARAT"
        },
        {
            "districtId": 297,
            "districtName": "SIBERUT UTARA"
        }
    ],
    "additionalInfo": {},
    "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