Test Scheduler

POST/dana/recurring/subscription/testScheduler.htm

This API is used to manually trigger subscription scheduler (only use in offline environment)

API Type

DANA Open API

Expected Timeout

3 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.recurring.openapi.subscription.testScheduler

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)

---

subscriptionId

string

1 - 64 charactersRequired

Subscription identifier

scheduleStatus

string

1 - 9 charactersRequired

Status to be trigger. The possible values are:

• SCHEDULED uses for triggering user reminder
• INITIAL uses for waiting from merchant to init the payment and for triggering payment notify

Test scheduler with SCHEDULED status

{
  "request":{
      "head":{
        "version":"1.0",
        "function":"dana.recurring.openapi.subscription.testScheduler",
        "clientId":"2020100656194771681084",
        "clientSecret":"f6299784fdf14011ac3c868e40dae074",
        "reqTime":"2021-01-21T12:08:56+07:00",
        "reqMsgId":"tester_scheduler_20210218_X001",
        "reserve":"{}"
      },
      "body":{
        "subscriptionId":"20210211111315800000DANAW3ID700300018932",
        "scheduleStatus":"SCHEDULED"
      }
  },
  "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.recurring.openapi.subscription.testScheduler

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 ResultStatusThe 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":"1.0",
        "function":"dana.recurring.openapi.subscription.testScheduler",
        "clientId":"2020100656194771681084",
        "clientSecret":"f6299784fdf14011ac3c868e40dae074",
        "respTime":"2021-01-21T12:08:56+07:00",
        "reqMsgId":"tester_scheduler_20210218_X001",
        "reserve":"{}"
      },
      "body":{
        "resultInfo":{
            "resultCodeId":"00000000",
            "resultMsg":"SUCCESS",
            "resultCode":"SUCCESS",
            "resultStatus":"S"
        }
      }
  },
  "signature":"signature string"
}

---

ResultStatus	ResultCodeId	ResultCode	ResultMessage	Solution
S	00000000	SUCCESS	success	Mark Test Scheduler process as Success
F	00000004	PARAM_ILLEGAL	parameter illegal	Mark Test Scheduler process as Failed. Retry request with proper parameter
U	00000900	SYSTEM_ERROR	system error	Mark Test Scheduler process as Failed. Retry request periodically. If error is raising, can contact to DANA to check the process