Create Shop

POST/dana/merchant/shop/createShop.htm

This API is used to create a new shop

API Type

DANA Open API

Expected Timeout

5 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.shop.createShop

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)

apiVersion

string

1 - 8 charactersRequired

API version. As per the respective API reference.
Notes: apiVersion > 2

merchantId

string

21 charactersRequired

Merchant identifier

parentDivisionId

string

Conditional

Parent division identifier. The length depend on parentRoleType:

DIVISION : 21 max
EXTERNAL_DIVISION : 64 max

Conditional Info

Y:= parentRoleType value is DIVISION or EXTERNAL_DIVISION

shopParentType

string

1 - 17 charactersRequired

Type of shop parent, 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

mainName

string

1 - 256 charactersRequired

Shop name

shopAddress

json object

Required

Shop 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

subDistrict

string

1 - 64 characters

Sub district

shopDesc

string

1 - 1024 characters

Shop description

externalShopId

string

1 - 64 charactersRequired

External shop 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

extInfo

json object

Required

Extended information. For the details, refer to extInfo params

PIC_EMAIL

Required

Shop's PIC email address
Notes: DANA will check the email format

PIC_PHONENUMBER

Required

Shop's PIC phone number
Notes: DANA will check the phone number format, contains: `^(62|\+62|62-|0)?(?!0+)(?=8)(\d{9,12})$`

SUBMITTER_EMAIL

Required

Submitter email address
Notes: DANA will check the email format

GOODS_SOLD_TYPE

Required

Type of the product business. The possible values are:

DIGITAL
NON_DIGITAL
SERVICES

USECASE

Required

Use case of the available products. The possible values are:

QRIS_DIGITAL
QRIS_NON_DIGITAL
QRIS_SERVICE
WIDGET_DIGITAL
WIDGET_NON_DIGITAL
WIDGET_SERVICE
DISBURSE_REFUND
DISBURSE_GAMIFICATION
DISBURSE_MONEY_TRANSFER

USER_PROFILING

Required

This param is used for merchants to inform DANA whether the target customers for their products are B2B or end user

AVG_TICKET

Required

Average daily transactions

OMZET

Required

Annual transaction revenue. The possible values are:

<2BIO
2BIO-5BIO
5BIO-10BIO
>10BIO

EXT_URLS

Required

Extension URL. This param is used to upload image for products sold

sizeType

string

1 - 4 charactersRequired

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

string

1 - 10 characters

Longitude of shop's location

lat

string

1 - 10 characters

Latitude of shop's location

loyalty

string

1 - 5 characters

Flag for loyalty category. The possible value are true or false

ownerAddress

json object

Required

Owner 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

subDistrict

string

1 - 64 characters

Sub district

ownerName

json object

Required

Owner name, refer to userName

firstName

string

1 - 64 charactersRequired

First name

lastName

string

1 - 64 charactersRequired

Last name

ownerPhoneNumber

json object

Required

Owner phone number, refer to mobileNoInfo

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 charactersRequired

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

ownerIdNo

string

Required

Owner identifier number. The length depend on ownerIdType:

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

deviceNumber

string

Required

Device number

posNumber

string

Required

Pos number

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 MCC

businessEntity

string

1 - 12 charactersRequired

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

shopOwning

string

1 - 12 charactersRequired

Shop owning information, refer to shopOwning

DIRECT OWNED

string

Shop is owned by direct owner

FRANCHISED

string

Shop is owned by franchise

shopBizType

string

1 - 6 charactersRequired

Shop business type, refer to shopBizType

OFFLINE

string

Shop location is offline

ONLINE

string

Shop location is online

businessDocs

array of json object

Required

Business document, refer to businessDoc.
Notes:

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

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

Required

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

taxNo

string

15 charactersRequired

Tax number (NPWP)

taxAddress

json object

1 - 256 charactersRequired

Tax 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

subDistrict

string

1 - 64 characters

Sub district

brandName

string

1 - 256 charactersRequired

Brand name on legal name or tax name

directorPics

array of json object

Required

Director as a PIC of shop, refer to businessPic

picName

string

1 - 64 charactersRequired

Business PIC name

picPosition

string

1 - 64 charactersRequired

Business PIC position

nonDirectorPics

array of json object

Required

Non director which become an PIC of shop, refer to businessPic

picName

string

1 - 64 charactersRequired

Business PIC name

picPosition

string

1 - 64 charactersRequired

Business PIC position

{
 "request":{
    "head":{
       "version":"2.0",
       "function":"dana.merchant.shop.createShop",
       "clientId":"2014000014442",
       "clientSecret":"2014000014442",
       "reqTime":"2022-03-22T14:45:43+07:00",
       "reqMsgId":"1234567asdfasdf1123fda",
       "reserve":"{}"
    },
    "body":{
       "apiVersion":"3",
       "merchantId":"216622222444445555555",
       "parentDivisionId":"216622222444445555555",
       "shopParentType":"MERCHANT",
       "mainName":"divisionName1",
       "shopAddress":{
          "country":"country",
          "province":"province",
          "city":"city",
          "area":"area",
          "address1":"address1",
          "address2":"address2",
          "postcode":"postcode",
          "subDistrict":"subDistrict"
       },
       "shopDesc":"description",
       "externalShopId":"shop1",
       "logoUrlMap":{
          "PC_LOGO":"base64ImageCodexxxxxxxxxxx"
       },
       "extInfo": {
          "PIC_EMAIL": "myshop_pic@email.com",
          "PIC_PHONENUMBER": "62-81234567890",
          "SUBMITTER_EMAIL": "admin_merchant@email.com",
          "GOODS_SOLD_TYPE": "DIGITAL",
          "USECASE": "QRIS_DIGITAL",
          "USER_PROFILING": "B2B",
          "AVG_TICKET": "100000-500000",
          "OMZET": "5BIO-10BIO",
          "EXT_URLS": "https://www.instagram.com",
       },
       "sizeType":"UMI",
       "ln":"106.84513",
       "lat":"-6.21462",
       "loyalty":"true",
       "ownerAddress":{
          "country":"country",
          "province":"province",
          "city":"city",
          "area":"area",
          "address1":"address1",
          "address2":"address2",
          "postcode":"postcode",
          "subDistrict":"subDistrict"
       },
       "ownerName":{
          "firstName":"Jane",
          "lastName":"Doe"
       },
       "ownerPhoneNumber":{
          "mobileNo":"62800000000",
          "mobileId":"mobileId",
          "verified":"true"
       },
       "ownerIdType":"KTP",
       "ownerIdNo":"3172010000000000",
       "deviceNumber":"0",
       "posNumber":"0",
       "mccCodes":[
          "0783"
       ],
       "businessEntity":"individu",
       "shopOwning":"DIRECT_OWNED",
       "shopBizType":"ONLINE",
       "businessDocs":[
       {
          "docType":"KTP",
          "docId":"3172010000000000",
          "docFile":"stringbase64value"
       }
       ],
       "taxNo": "123456789012345",
       "taxAddress": {
          "country": "Indonesia",
          "province": "DKI Jakarta",
          "city": "Jakarta",
          "area": "area",
          "address1": "address1",
          "address2": "address2",
          "postcode": "14123"
       },
       "brandName": "XXX",
       "directorPics":[
       {
          "picName":"Agus",
          "picPosition":"DIRECTOR_FINANCE"
       }
       ],
       "nonDirectorPics":[
       {
          "picName":"Budi",
          "picPosition":"OPERATION"
       }
       ]
    }
 },
 "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.shop.createShop

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

shopId

string

21 charactersConditional

Shop identifier

Conditional Info

Y:= Successfully processed

 {
    "response":{
       "head":{
          "version":"2.0",
          "function":"dana.merchant.shop.createShop",
          "clientId":"211020000000000000044",
          "clientSecret": "2014000014442",
          "respTime":"2022-03-22T14:45:43+07:00",
          "reqMsgId":"1234567asdfasdf1123fda",
          "reserve":"{}"
       },
       "body":{
          "resultInfo":{
             "resultStatus":"S",
             "resultCodeId":"00000000",
             "resultCode":"SUCCESS",
             "resultMsg":"success"
          },
          "shopId":"2166522222222222"
       }
    },
    "signature":"signature string"
 }

ResultStatus	ResultCodeId	ResultCode	ResultMessage	Partner Action
S	00000000	SUCCESS	success	Mark Create Shop process as Success
F	00000004	PARAM_ILLEGAL	parameter illegal	Mark Create Shop process as Failed. Retry request with proper parameter
F	00000900	SYSTEM_ERROR	system error	Mark Create Shop process as Failed. Retry request periodically
F	12015201	MERCHANT_NOT_EXIST	merchant not exist	Mark Create Shop process as Failed. Retry request with proper parameter or can contact to DANA to check merchant configuration
F	12015202	MERCHANT_STATUS_ERROR	merchant status is not normal	Mark Create Shop process as Failed. Retry request with proper parameter or can contact to DANA to check merchant configuration
F	12015203	DIVISION_NOT_EXIST	parent division not exist	Mark Create Shop process as Failed. Retry request with proper parameter or can contact to DANA to check parent division configuration
F	12015204	DIVISION_STATUS_ERROR	parent division status is not normal	Mark Create Shop process as Failed. Retry request with proper parameter or can contact to DANA to check parent division configuration
F	12015206	ROLE_HAS_EXIST	shop has existed	Mark Create Shop process as Failed. Retry request with proper parameter

Create Shop​

Create Shop