Subscription Reminder Scheduled Payment

POST{partnerUrl}

This API is used to reminder merchant about schedule of subscription

API Type

DANA Open API

Expected Timeout

8 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.recurring.subscription.ipg.init

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

merchantId

string

21 charactersRequired

Merchant identifier that is unique per each merchant

productName

string

1 - 128 charactersRequired

Merchant product name

scheduleTime

string

25 charactersRequired

Time when merchant have to trigger payment, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)

publicId

string

1 - 64 characters

Static unique identifier for one user and one merchant

transactionId

string

1 - 64 charactersRequired

Transaction identifier

{
   "request":{
      "head":{
         "version":"1.0",
         "function":"dana.recurring.subscription.ipg.init",
         "clientId":"2014000014442",
         "clientSecret":"2014000014442",
         "reqTime":"2020-07-04T12:08:56+07:00",
         "reqMsgId":"1234567asdfasdf1123fda",
         "reserve":"{}"
      },
      "body":{
         "subscriptionId":"20200730111315800000DANAW3ID009500131053",
         "merchantId":"21662xxxxxxxx",
         "productName":"Awesome product",
         "scheduleTime":"2020-07-04T12:08:56+07:00",
         "publicId":"1234567890",
         "transactionId":"20200831111315800000DANAW3ID007400217089"
      }
   },
   "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.subscription.ipg.init

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.subscription.ipg.init",
         "clientId":"2014000014442",
         "clientSecret":"2014000014442",
         "respTime":"2020-07-04T12:08:56+07:00",
         "reqMsgId":"1234567asdfasdf1123fda",
         "reserve":"{}"
      },
      "body":{
         "resultInfo":{
            "resultStatus":"S",
            "resultCodeId":"00000000",
            "resultCode":"SUCCESS",
            "resultMsg":"success"
         }
      }
   },
   "signature":"signature string"
}

ResultStatus	ResultCodeId	ResultCode	ResultMessage	Solution
S	00000000	SUCCESS	success	Mark Subscription Reminder Scheduled Payment process as Success
U	00000900	SYSTEM_ERROR	system error	Mark Subscription Reminder Scheduled Payment process as Failed. Retry request periodically