Check Disbursement Account

POSTdana/merchant/queryMerchantResource.htm

This API is used to check merchant’s account balance for disbursement account

API Type

DANA Open API

Expected Timeout

8 second

SNAP Service Code

-

Accept

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

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)

---

requestMerchantId

string

21 charactersRequired

Merchant identifier

merchantResourceInfoList

array of string

Required

Merchant resource information for request.
Refer to MerchantResourceEnum for the possible values

MERCHANT_AVAILABLE_BALANCE

string

Query the available balance that can be used by merchant

MERCHANT_TOTAL_BALANCE

string

Query the total balance, which combine the Merchant Payable Account and the Merchant Settlement Account

MERCHANT_DEPOSIT_BALANCE

string

Query the deposit balance that can be used by merchant for disbursement solution

{
  "request": {
      "head": {
          "version": "2.0",
          "function": "dana.merchant.queryMerchantResource",
          "clientId": "201xxxx",
          "clientSecret": "201xxx",
          "reqTime": "2019-09-18T10:21:53+07:00",
          "reqMsgId": "1234567asdfasdf1123fda",
          "reserve": "{}"
      },
      "body": {
          "requestMerchantId": "216xxxxxxxxxxxxxx",
          "merchantResourceInfoList": [
              "MERCHANT_DEPOSIT_BALANCE"
          ]
      }
  },
  "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.queryMerchantResource

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

Response 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

merchantResourceInformations

array of json object

Conditional

Define the detail of merchant resource information

Conditional Info

Y:= Successfully processed

resourceType

string

Required

The type of returned resource

MERCHANT_AVAILABLE_BALANCE

string

Query the available balance that can be used by merchant

MERCHANT_TOTAL_BALANCE

string

Query the total balance, which combine the Merchant Payable Account and the Merchant Settlement Account

MERCHANT_DEPOSIT_BALANCE

string

Query the deposit balance that can be used by merchant for disbursement solution

value

string

Conditional

Value on resource type

Conditional Info

Y:= Value is exist

{
  "response":{
      "head":{
        "version":"2.0",
        "function":"dana.merchant.queryMerchantResource",
        "clientId":"201xxxx",
        "clientSecret":"201xxx",
        "reqTime":"2019-09-18T10:21:53+07:00",
        "reqMsgId":"1234567asdfasdf1123fda",
        "reserve":"{}"
      },
      "body":{
        "resultInfo":{
            "resultStatus":"S",
            "resultCodeId":"00000000",
            "resultCode":"SUCCESS",
            "resultMsg":"success"
        },
        "merchantResourceInformations":[
            {
              "resourceType":"MERCHANT_DEPOSIT_BALANCE",
              "value":"{\"amount\":\"0\",\"currency\":\"IDR\"}"
            }
        ]
      }
  },
  "signature":"signature string"
}

---

ResultStatus	ResultCodeId	ResultCode	ResultMessage	Partner Action
S	00000000	SUCCESS	Success	Mark Check Disbursement Account process as Success
F	00000004	PARAM_ILLEGAL	parameter illegal	Mark Check Disbursement Account process as Failed. Retry request with proper parameter
U	00000900	SYSTEM_ERROR	system error	Mark Check Disbursement Account process as Failed. Retry request periodically
F	12158006901	MERCHANT_NOT_EXIST	Merchant not exist	Mark Check Disbursement Account process as Failed. Retry request with proper parameter or can contact to DANA to check merchant configuration