Get Division List

POST/dana/merchant/division/getDivisionList.htm

This API is used to obtain division list

API Type

DANA Open API

Expected Timeout

3 second

SNAP Service Code

application/json

Content Type

application/json

version

string

1 - 8 charactersRequired

API version. As per the respective API reference

function

string

1 - 128 charactersRequired

According to specifications defined by each business domain.
Value: dana.merchant.division.getDivisionList

clientId

string

1 - 36 charactersRequired

Client identifier which provided by DANA and used to identify partner and application system

clientSecret

string

1 - 64 charactersRequired

As a secret key of client. Assigned client secret during registration

reqTime

string

25 charactersRequired

Request time, in format YYYY-MM-DDTHH:mm:ss+07:00.
Time must be in GMT+7 (Jakarta time)

reqMsgId

string

1 - 64 charactersRequired

Identify an unique system request. Each request will be assigned with a unique identifier (UUID)

reserve

string

1 - 256 characters

Reserved for future implementation (Key/Value)

merchantId

string

21 charactersConditional

Merchant identifier

Conditional Info

Y:= parentIdType is EXTERNAL_ID

parentId

string

Required

Parent identifier. The value depend on parentIdType:

INNER_ID: 21 max
EXTERNAL_ID: 64 max

parentIdType

string

1 - 11 charactersRequired

Parent identifier type, refer to parentIdType

INNER_ID

string

Parent identifier is generated by DANA

EXTERNAL_ID

string

Parent identifier is provided by merchant

pageNum

string

Page number

pageSize

string

Page size

{
    "request": {
      "head": {
          "version": "2.0",
          "function": "dana.merchant.division.getDivisionList",
          "clientId": "2014000014442",
          "clientSecret": "2014000014442",
          "reqTime": "2001-07-04T12:08:56+05:30",
          "reqMsgId": "1234567asdfasdf1123fda",
          "reserve": "{}"
    },
        "body": {
          "merchantId": "216622222444445555555",
          "parentId": "2166522222222222",
          "parentIdType": "INNER_ID",
          "pageSize" : "10",
          "pageNum" : "1"
        }
    },
    "signature": "signature string"
}

version

string

1 - 8 charactersRequired

API version. As per the respective API reference

function

string

1 - 128 charactersRequired

According to specifications defined by each business domain.
Value: dana.merchant.division.getDivisionList

clientId

string

1 - 36 charactersRequired

Client identifier which provided by DANA and used to identify partner and application system

clientSecret

string

1 - 64 charactersRequired

As a secret key of client. Assigned client secret during registration

respTime

string

25 charactersRequired

Request time, in format YYYY-MM-DDTHH:mm:ss+07:00.
Time must be in GMT+7 (Jakarta time)

reqMsgId

string

1 - 64 charactersRequired

Identify an unique system request. Each request will be assigned with a unique identifier (UUID)

reserve

string

1 - 256 characters

Reserved for future implementation (Key/Value)

resultInfo

json object

Required

Define the detail of result information

resultStatus

string

1 charactersRequired

Result status, refer to result code list ResultStatus
The status of the request can be:

S: Success
F: Failure
U: Unknown

Can be added if these 3 statuses are insufficient for business requirements

resultCodeId

string

1 - 16 charactersRequired

Result code identifier, refer to result code list ResultCodeId

resultCode

string

1 - 64 charactersRequired

Result code string, refer to ResultCode

resultMsg

string

1 - 256 characters

Result message, refer to result code list ResultMsg

divisionResourceInfo

json object

Conditional

Define the detail of division resource information, refer to divisionResourceInfo

Conditional Info

Y:= Successfully processed

merchantId

string

21 charactersRequired

Merchant identifier

parentRoleType

string

1 - 17 charactersRequired

Type of parent role, refer to parentRoleType

MERCHANT

string

Parent role type is merchant

DIVISION

string

Parent role type is division

EXTERNAL_DIVISION

string

Parent role type is external division

divisionName

string

1 - 256 charactersRequired

Division name

contactAddress

json object

Required

Contact address, refer to addressInfo

country

string

1 - 64 charactersRequired

Country name

province

string

1 - 64 charactersRequired

Province name

city

string

1 - 64 charactersRequired

City name

area

string

1 - 64 charactersRequired

Area name

address1

string

1 - 256 charactersRequired

Information of address 1

address2

string

1 - 256 charactersRequired

Information of address 2

postcode

string

5 charactersRequired

Postcode

divisionType

string

1 - 11 charactersRequired

Division type, refer to divisionType

REGION

string

Division type is region

SUBMERCHANT

string

Division type is sub merchant

externalDivisionId

string

1 - 64 charactersRequired

External division identifier

logoUrlMap

array of string

Conditional

Logo URL, the map keys are:

LOGO
PC_LOGO
MOBILE_LOGO

Notes: The logo's value is the string which is the image's data encoded with base64 and image type must PNG format

Conditional Info

Y:= Data is exists

extInfo

array of string

Conditional

Extend info, the map keys are:

LOGO
PC_LOGO
MOBILE_LOGO

Conditional Info

Y:= Data is exists

mccCodes

array of string

1 - 64 charactersConditional

Merchant category code, used to identify the type of business in which a merchant is engaged, refer to Merchant Category Code

Conditional Info

Y:= Data is exists

divisionId

string

21 charactersRequired

Division identifier

parentDivisionId

string

1 - 64 characters

Parent division identifier. The length depend on parentRoleType:

MERCHANT: 21 max
DIVISION: 21 max
EXTERNAL_DIVISION: 64 max

pgDivisionFlag

string

1 - 5 characters

Flag if division is type PG. The possible values are true or false

pageNum

string

Page number

pageSize

string

Page size

count

string

Number of selected data

hasNext

string

1 - 5 characters

Determine whether the data is on the last page or not. The possible values are true or false
Notes: Will be false if the data on the last page

{
  "response": {
      "head": {
          "version":"2.0",
          "function":"dana.merchant.division.getDivisionList",
          "clientId":"211020000000000000044",
          "clientSecret": "2014000014442",
          "respTime":"2001-07-04T12:08:56+05:30",
          "reqMsgId":"1234567asdfasdf1123fda",
          "reserve":"{}"
      },
      "body": {
          "resultInfo": {
              "resultStatus": "S",
              "resultCodeId": "00000000",
              "resultCode": "SUCCESS",
              "resultMsg": "success"
          },
          "divisionResourceInfoList": [{
              "parentDivisionId": "216622222444445555555",
              "parentRoleType": "MERCHANT",
              "divisionName": "divisionName1",
              "contactAddress": {
                  "country": "country",
                  "province": "province",
                  "city": "city",
                  "area": "area",
                  "address1": "address1",
                  "address2": "address2",
                  "postcode": "12214"
              },
              "divisionType": "divisionType",
              "externalDivisionId" : "externalDivisionId",
              "logoUrlMap": {
                  "PC_LOGO": "base64ImageCodexxxxxxxxxxx"
              },
              "extInfo": "{}",
              "mccCodes": ["01231","12345"]
          }],
        "pageSize" : "10",
        "pageNum" : "1",
        "count" : "1",
        "hasNext" : "false"
      }
  },
"signature": "signature string"
}

ResultStatus	ResultCodeId	ResultCode	ResultMessage	Solution
S	00000000	SUCCESS	success	Mark Get Division List process as Success
F	00000004	PARAM_ILLEGAL	parameter illegal	Mark Get Division List process as Failed. Retry request with proper parameter
F	00000900	SYSTEM_ERROR	system error	Mark Get Division List process as Failed. Retry request periodically