Recurring
- Description: Proceed recurring payment with the token
- Path:
/tokenization/recurring
- Method:
POST
- Request Header:
Content-Type: application/json
#
Request ParametersParameter | Type | Required/ optional | Description |
---|---|---|---|
merchantId | string | Required | Merchant identifier |
userId | string | Required | Merchant's user identifier |
tokenId | number | Required | Token identifier |
reason | string | Required | Recurring reason |
amount | number | Required | Recurring amount |
merchantReference | string | Required | An unique reference to identify this recurring order, different from the sale merchantReference |
parentOrderId | number | Required | Order ID which is returned from response of API Sale: /tokenization/sale |
callbackUrl | object | Optional | |
callbackUrl.success | string | Optional | An URL to redirect after successful payment |
callbackUrl.fail | string | Optional | An URL to redirect after failed payment |
callbackUrl.cancel | string | Optional | An URL to redirect when payment is cancelled |
callbackUrl.notify | string | Optional | Listening endpoint in merchant's backend to receive notification |
#
Example:#
Response ParametersParameter | Type | Require | Description |
---|---|---|---|
responseCode | string | Required | Payment Gateway response code |
message | string | Required | Payment Gateway response message |
order | object | Required | |
order.id | number | Required | Order identifier |
order.merchantId | number | Required | Merchant identifier which own this order |
order.merchantReference | string | Required | Your reference for the order |
order.currency | string | Required | 3-Letters ISO currency code of the order |
order.amount | number | Required | Order amount |
order.netAmount | number | Required | Net amount of the order |
order.cardType | string | Required | Card type of the order |
order.email | string | Required | Customer's email if provided |
order.createTime | datetime | Required | Timestamp when the order is created. Maintained by the Payment Gateway |
order.updateTime | datetime | Required | Timestamp when the order is last updated. Maintained by the Payment Gateway |
order.status | string | Required | Status of the order. Maintained by the Payment Gateway |
order.recurring | boolean | Required | Flags the order is a recurring order or not |
transaction | object | Required | |
transaction.id | number | Required | Transaction identifier for the recurring transaction |
transaction.merchantId | number | Required | Merchant identifier which own this transaction |
transaction.type | string | Required | Transaction type |
transaction.amount | string | Required | Transaction amount |
transaction.status | string | Required | Status of the transaction. Maintained by the Payment Gateway |
transaction.maskedPan | string | Required | Masked card number of the recurring transaction if supported by the payment method |
transaction.stan | string | Required | System trace audit number for the transaction |