Update Division

POST/dana/merchant/division/updateDivision.htm

This API is used to update the division information

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.updateDivision

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 charactersRequired

Merchant identifier

divisionId

string

21 charactersConditional

Division identifier

Conditional Info

Y:= divisionIdType is INNER_ID

divisionName

string

1 - 256 charactersRequired

Division name

divisionAddress

json object

Required

Division 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

divisionDescription

string

1 - 1024 characters

Division description

divisionType

string

1 - 11 charactersRequired

Division type, refer to divisionType

REGION

string

Division type is region

SUBMERCHANT

string

Division type is sub merchant

divisionIdType

string

1 - 11 charactersRequired

Division identifier type, refer to divisionIdType

INNER_ID

string

Division identifier is generated by DANA

EXTERNAL_ID

string

Division identifier is provided by merchant

externalDivisionId

string

1 - 64 charactersConditional

External division identifier

Conditional Info

Y:= divisionIdType is EXTERNAL_ID

newExternalDivisionId

string

1 - 64 charactersRequired

New external division identifier

logoUrlMap

array of string

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

mccCodes

array of string

1 - 64 charactersRequired

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

extInfo

string

1 - 64 charactersRequired

Extend information

apiVersion

string

1 - 8 charactersConditional

API version. As per the respective API reference

Conditional Info

Y:= Need to add new attributes

businessDocs

array of json object

Conditional

Business document, refer to businessDoc
Notes:

BusinessEntity individu can only use businessDoc.docType KTP and SIM
Other BusinessEntity can only use SIUP and NIB

Conditional Info

Y:= apiVersion > 2

docType

string

1 - 8 charactersRequired

Business document type, refer to ownerIdType

KTP

string

Use KTP as an owner identifier

SIM

string

Use SIM as an owner identifier

PASSPORT

string

Use passport as an owner identifier

NIB

string

Use Nomor Induk Berusaha (NIB) as an owner identifier

SIUP

string

Use Surat Izin Usaha Perdagangan (SIUP) as an owner identifier

docId

string

1 - 16 charactersRequired

Business document identifier number. The length depend on docType:

KTP: 16
SIM: 12-14
Passport: 8
NIB: >= 13
SIUP: Free text

docFile

string (base64)

Required

Business document file in base64 String, accepted file extensions: PDF, GIF, PNG

businessEntity

string

1 - 12 charactersConditional

Business entity, refer to businessEntity

individu

string

Business is individual

string

Business entity is Perseroan Terbatas (PT)

string

Business entity is Commanditaire Vennootschap/Persekutuan Komanditer (CV)

yayasan

string

Business entity is foundation

usaha_dagang

string

Business entity is market

koperasi

string

Business entity is Koperasi

Conditional Info

Y:= apiVersion > 2

businessEndDate

string

1 - 10 charactersConditional

Business end date, in format YYYY-MM-DD

Conditional Info

Y:= apiVersion > 2

ownerName

json object

Conditional

Owner name, refer to userName

Conditional Info

Y:= apiVersion > 2

firstName

string

1 - 64 charactersRequired

First name

lastName

string

1 - 64 charactersRequired

Last name

ownerPhoneNumber

json object

Conditional

Owner phone number, refer to mobileNoInfo

Conditional Info

Y:= apiVersion > 2

mobileId

string

1 - 32 charactersRequired

Mobile identifier

mobileNo

string

1 - 32 charactersRequired

Mobile phone number

verified

string

1 - 5 charactersRequired

Flag for verified mobile, the possible values are true or false

ownerIdType

string

1 - 8 charactersConditional

Owner identifier type, refer to ownerIdType

KTP

string

Use KTP as an owner identifier

SIM

string

Use SIM as an owner identifier

PASSPORT

string

Use passport as an owner identifier

NIB

string

Use Nomor Induk Berusaha (NIB) as an owner identifier

SIUP

string

Use Surat Izin Usaha Perdagangan (SIUP) as an owner identifier

Conditional Info

Y:= apiVersion > 2

ownerIdNo

string

1 - 16 charactersConditional

Owner identifier number. The length depend on ownerIdType:

KTP: 16
SIM: 12-14
Passport: 8
NIB: >= 13
SIUP: Free text

Conditional Info

Y:= apiVersion > 2

ownerAddress

json object

Conditional

Owner address, refer to addressInfo

Conditional Info

Y:= apiVersion > 2

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

directorPics

array of json object

Conditional

Director as a PIC of sub merchant, refer to businessPic

Conditional Info

Y:= apiVersion > 2

picName

string

1 - 64 charactersRequired

Business PIC name

picPosition

string

1 - 64 charactersRequired

Business PIC position

nonDirectorPics

array of json object

Conditional

Non director which become an PIC of sub merchant, refer to businessPic

Conditional Info

Y:= apiVersion > 2

picName

string

1 - 64 charactersRequired

Business PIC name

picPosition

string

1 - 64 charactersRequired

Business PIC position

sizeType

string

1 - 4 charactersConditional

Size type, refer to sizeType

UMI

string

Usaha Mikro

UKE

string

Usaha Kecil

UME

string

Usaha Menengah

UBE

string

Usaha Besar

URE

string

Usaha Reguler

Conditional Info

Y:= apiVersion > 2

pgDivisionFlag

string

1 - 5 characters

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

{
"request": {
    "head": {
        "version": "2.0",
        "function": "dana.merchant.division.updateDivision",
        "clientId": "2014000014442",
        "clientSecret": "2014000014442",
        "reqTime": "2001-07-04T12:08:56+05:30",
        "reqMsgId": "1234567asdfasdf1123fda",
        "reserve": "{}"
    },
    "body": {
        "merchantId": "21662xxx383",
        "divisionId": "21665xxx385",
        "divisionName": "divisionName",
        "divisionAddress": {
            "country": "country",
            "province": "province",
            "city": "city",
            "area": "area",
            "address1": "address1",
            "address2": "address2",
            "postcode": "zipcode"
        },
        "divisionDescription": "description",
        "divisionType": "REGION",
        "divisionIdType": "INNER_ID",
        "externalDivisionId": "35205452Division",
        "newExternalDivisionId": "35205452Division",
        "logoUrlMap": {
            "PC_LOGO": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
        },
        "mccCodes": [
            "90075",
            "90040"
        ],
        "extInfo": {
            "key": "value"
        },
        "apiVersion": "3",
        "businessDocs": {
            "docId": "777xxxxxxxxxx111",
            "docType": "KTP",
            "docUrl": "https://www.test.com"
        },
        "businessEntity": "individu",
        "businessEndDate": "2021-05-26",
        "ownerName": {
            "firstName": "Udin",
            "lastName": "Sukiman"
        },
        "ownerPhoneNumber": {
            "mobileId": "12xxxxx23",
            "mobileNo": "62-xxxxxxxxx12",
            "verified": "true"
        },
        "ownerIdType": "KTP",
        "ownerIdNo": "31xxxxxxxxxxxx00",
        "ownerAddress": {
            "country": "Indonesia",
            "province": "DKI Jakarta",
            "city": "Kota Jakarta Selatan",
            "area": "Kebayoran Lama",
            "address1": "Jl. Kebayoran Lama 1 No. 2",
            "address2": "Jl. Kebayoran Lama 1 No. 3",
            "postcode": "14045",
            "subDistrict": "test"
        },
        "directorPics": [{
            "picName": "John",
            "picPosition": "CTO"
        }],
        "nonDirectorPics": [{
            "picName": "Ethan",
            "picPosition": "CEO"
        }],
        "sizeType": "URE",
        "pgDivisionFlag": "true"
    }
 },
"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.updateDivision

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

{
"response": {
    "head": {
        "version":"2.0",
        "function":"dana.merchant.division.updateDivision",
        "clientId":"211020000000000000044",
        "clientSecret": "2014000014442",
        "respTime":"2001-07-04T12:08:56+05:30",
        "reqMsgId":"1234567asdfasdf1123fda",
        "reserve":"{}"
    },
    "body": {
        "resultInfo": {
            "resultCodeId": "00000000",
            "resultCode": "SUCCESS",
            "resultMsg": "SUCCESS",
            "resultStatus": "S"
        }
     }
  },
"signature": "string"
}

ResultStatus	ResultCodeId	ResultCode	ResultMessage	Partner Action
S	00000000	SUCCESS	success	Mark Update Division process as Success
F	00000004	PARAM_ILLEGAL	parameter illegal	Mark Update Division process as Failed. Retry request with proper parameter
F	00000900	SYSTEM_ERROR	system error	Mark Update Division process as Failed. Retry request periodically
F	12015980	DIVISION_NOT_EXIST	division not exist	Mark Update Division process as Failed. Retry request with proper parameter
F	12015984	DIVISION_NOT_AVAILABLE	division not available for update	Mark Update Division process as Failed. Retry request with proper parameter or can contact to DANA to check division configuration

Update Division​

Update Division