Credit Card Subscription
Credit Card Subscription Query API
Query subscription status for credit card.
Request URL
URL: ${ROOT_URL}/cc/v1/sub/querysub
HTTPMethod: POST
EndpointUrl: /cc/v1/sub/querysub
Subscription Query Request Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Fixed value "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Current time, format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. For details see Data Signing Rules | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | Unique ID for each request | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Unique identifier on every request |
| merchantId | String(20) | Yes | Unique ID provided by payment gateway to merchant |
| storeId | String(30) | No | If merchant has branches and wants to create order using branch ID |
| paymentType | String(20) | Yes | Payment type |
| agreementId | String(32) | Yes | Agreement ID, obtained via subscription order query |
Subscription Query Response Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Fixed value "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Current time, format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. For details see Data Signing Rules | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | Unique ID for each request | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Unique ID for each request |
| errCode | String(32) | No | 0 means success, otherwise see Error Code |
| errCodeDes | String(128) | No | Error description |
| merchantId | String(20) | Yes | Unique ID provided by payment gateway to merchant |
| storeId | String(30) | No | If using branch ID |
| paymentType | String(20) | Yes | Payment type |
| requestAmount | Decimal(12,2) | No | Amount at request |
| amount | decimal(12,2) | Yes | Amount in IDR, with 2 decimals |
| agreementId | String(32) | Yes | Agreement ID |
| createTime | String(16) | No | yyyyMMddHHmmss |
| status | String(32) | No | INIT: request created, ACTIVE: subscription active, FAILED: request failed |
| expiredDate | String(10) | Yes | Expiry date yyyy-MM-dd |
| notifyUrl | String(200) | No | URL for reminder/cancel/complete notification |
| returnUrl | String(200) | No | Frontend return URL for initial subscription |
| subTitle | String(128) | Yes | Subscription title |
| subMessage | String(256) | No | Subscription description |
| + subInterval | Object | Yes | DAILY/WEEKLY/MONTHLY |
| - type | String(10) | Yes | DAILY: Day, WEEKLY: Week, MONTHLY: Month |
| - value | Number(2) | Yes | Interval value, 1-99 |
| + productInfo | Object | Yes | Recurring product/service details |
| - id | String(10) | Yes | Product ID |
| - name | String(32) | Yes | Product Name |
| - price | decimal(12,2) | Yes | Amount in IDR, supports two decimals |
| - type | String(20) | Yes | Product Type |
| - url | String(200) | No | Product URL |
| - quantity | Number(4) | Yes | Product Quantity |
| + paymentInfo | Array<Object> | No | Subscription transaction history |
| - successTime | String(16) | No | yyyyMMddHHmmss |
| - platformTradeNo | String(32) | No | Paylabs platform order number |
| - amount | Decimal(12,2) | No | Amount in IDR, 2 decimals |
| - status | String(32) | No | 01 PENDING 09 FAILED 02 SUCCEEDED |
| - transFeeRate | Decimal(6,6) | No | Transaction fee rate |
| - transFeeAmount | Decimal(12,2) | No | Fee, two decimals |
| - totalTransFee | Decimal(12,2) | No | Total fee (excl. VAT) |
| - vatFee | Decimal(12,2) | No | VAT fee |