Skip to main content

Query Subscription Transaction

POST/dana/recurring/subscription/querySubscriptionTransaction.htm

This API is used to obtain information of payment/transaction regarding subscription

API Type
DANA Open API
Expected Timeout
3 second
SNAP Service Code
00
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.querySubscriptionTransaction
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
status
array of string
1 - 7 characters
Status of payment/transaction. The possible values are:
  • INIT means payment is processing
  • SUCCESS means payment is successful
  • FAILED means payment is failed;
Note

If the status is empty, the response will return all record with all statuses

pageNum
integer
Required
Number of page. The value must be not null and greater than zero
pageSize
integer
Required
Record size per page. The value must be not null and greater than zero
envInfo
json object
Required
Environment information. The envInfo include the parameter of:
  • sourcePlatform: The value must be IPG
  • terminalType: The value must be APP
{
  "request":{
      "head":{
        "version":"1.0",
        "function":"dana.recurring.openapi.subscription.querySubscriptionTransaction",
        "clientId":"2014000014442",
        "clientSecret":"2014000014442",
        "reqTime":"2001-07-04T12:08:56+07:00",
        "reqMsgId":"1234567asdfasdf1123fda",
        "reserve":"{}"
      },
      "body":{
        "subscriptionId":"20200630111315800000DANAW3ID565600012305",
        "status":[
            "SUCCESS",
            "FAILED"
        ],
        "pageNum":1,
        "pageSize":10,
        "envInfo":{
            "sourcePlatform":"IPG",
            "terminalType":"APP"
        }
      }
  },
  "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.querySubscriptionTransaction
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
bizOrderInfoList
array of json object
Required
Define the detail of subscription biz order (payment/transaction) information.
Note
  • If no records found, the response will return an empty list
  • Records are already sorted by the latest
subscriptionId
string
1 - 64 charactersRequired
Subscription identifier
trxId
string
1 - 64 charactersRequired
Transaction identifier
externalTrxId
string
1 - 64 charactersConditional
Acquiring transaction identifier
Conditional Info
Y:= status is SUCCESS or FAILED
goodsType
string
17 charactersRequired
General goods type for merchant which determined by DANA. The value must be filled with EXTERNAL_MERCHANT
trxAmount
money
Conditional
Transaction amount. Contains two sub-fields:
  1. Amount: Transaction amount, including the cents
  2. Currency: Currency code based on ISO
Conditional Info
Y:= status is SUCCESS
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point
e.g., IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
trxStatus
string
1 - 7 charactersRequired
Status of payment/transaction. The possible values are:
  • INIT means payment is processing
  • SUCCESS means payment is successful
  • FAILED means payment is failed
extInfo
json object
Conditional
Define the detail of extended information.
Conditional Info
Y:= status is SUCCESS or FAILED
BIZ_ORDER_ID
string
1 - 64 characters
Biz order identifier
BIZ_DATE
string
10 characters
Transaction date, in format YYYY-MM-DD
PAYMENT_AMOUNT
money
Total amount which need to be paid. Contains two sub-fields:
  1. Amount: Transaction amount, including the cents
  2. Currency: Currency code based on ISO
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point
e.g., IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
ACTUAL_PAYMENT_AMOUNT
money
Total actual amount which have been paid (after deduct from promo or others). Contains two sub-fields:
  1. Amount: Transaction amount, including the cents
  2. Currency: Currency code based on ISO
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point
e.g., IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
MERCHANT_TRANS_ID
string
1 - 64 characters
Transaction identifier by merchant
DEDUCT_FAILED_REASON
string
1 - 64 characters
Reason of deduct failed
paginator
json object
Required
Define the detail of pagination information.
pageNum
integer
1 - 2 characters
Current page number
pageSize
integer
1 - 2 characters
Maximum number of transaction returned in one pagination
totalCount
integer
1 - 4 characters
Count total
totalPage
integer
1 - 4 characters
Total of page
{
    "response":{
      "head":{
          "version":"1.0",
          "function":"dana.recurring.openapi.subscription.querySubscriptionTransaction",
          "clientId":"2014000014442",
          "clientSecret":"2014000014442",
          "respTime":"2001-07-04T12:08:56+07:00",
          "reqMsgId":"1234567asdfasdf1123fda",
          "reserve":"{}"
      },
      "body":{
          "resultInfo":{
            "resultStatus":"S",
            "resultCodeId":"00000000",
            "resultCode":"SUCCESS",
            "resultMsg":"success"
          },
          "bizOrderInfoList":[
            {
                "subscriptionId":"20200630111315800000DANAW3ID565600012305",
                "trxId":"20200630111315800000DANAW3ID565600044405",
                "externalTrxId":"20200630111315800000DANAW3ID565600044405",
                "goodsType":"EXTERNAL_MERCHANT",
                "trxAmount":"{\"amount\":\"120000\",\"currency\":\"IDR\"}",
                "trxStatus":"SUCCESS",
                "extInfo":{
                  "BIZ_ORDER_ID":"289832387634534",
                  "BIZ_DATE":"2020-10-10",
                  "PAYMENT_AMOUNT":"{\"amount\":\"120000\",\"currency\":\"IDR\"}",
                  "ACTUAL_PAYMENT_AMOUNT":"{\"amount\":\"120000\",\"currency\":\"IDR\"}",
                  "MERCHANT_TRANS_ID":"20200630111315",
                  "DEDUCT_FAILED_REASON":"Sample of reason"
                }
            },
            {
                "subscriptionId":"20200630111315800000DANAW3ID565600012305",
                "trxId":"20200630111315800000DANAW3ID56560003335",
                "externalTrxId":"20200630111315800000DANAW3ID565600033305",
                "goodsType":"EXTERNAL_MERCHANT",
                "trxAmount":"{\"amount\":\"120000\",\"currency\":\"IDR\"}",
                "trxStatus":"FAILED",
                "extInfo":{
                  "BIZ_ORDER_ID":"289832387634534",
                  "BIZ_DATE":"2020-10-10",
                  "PAYMENT_AMOUNT":"{\"amount\":\"120000\",\"currency\":\"IDR\"}",
                  "ACTUAL_PAYMENT_AMOUNT":"{\"amount\":\"120000\",\"currency\":\"IDR\"}",
                  "MERCHANT_TRANS_ID":"20200630111315",
                  "DEDUCT_FAILED_REASON":"Sample of reason"
                }
            }
          ],
          "paginator":{
            "pageNum":1,
            "pageSize":10,
            "totalCount":2,
            "totalPage":1
          }
      }
    },
    "signature":"signature string"
}
ResultStatusResultCodeIdResultCodeResultMessageSolution
S 00000000SUCCESSsuccess
Mark Query Subscription Transaction process as Success
F 00000004PARAM_ILLEGALparameter illegal
Mark Query Subscription Transaction process as Failed. Retry request with proper parameter
U 00000900SYSTEM_ERRORsystem error
Mark Query Subscription Transaction process as Failed. Retry request periodically. If error is raising, can contact to DANA to check the process
ask AIAI Assistant
Need help with our documentation?
Start from our frequently asked questions or feel free to ask anything else.

AI generated responses may contain mistakes.