Skip to main content

Recurring


  • Description: Proceed recurring payment with the token
  • Path: /tokenization/recurring
  • Method: POST
  • Request Header: Content-Type: application/json

Request Parameters

ParameterTypeMandatoryDescription
merchantIdStringMMerchant identifier
userIdString(64)MMerchant's user identifier, value is case insensitive
tokenIdNumberMToken identifier
reasonStringMRecurring reason
amountNumber(9,2)MRecurring amount
merchantReferenceString(64)MAn unique reference to identify this recurring order, different from the sale merchantReference
parentOrderIdNumberMOrder ID which is returned from response of API Sale: /tokenization/sale
callbackUrlObjectO 
callbackUrl.successStringOAn URL to redirect after successful payment
callbackUrl.failStringOAn URL to redirect after failed payment
callbackUrl.cancelStringOAn URL to redirect when payment is cancelled
callbackUrl.notifyStringOAn API URL in merchant's backend to receive notification

Example:

{
"request": "{\"merchantId\":3,\"userId\":\"user1\",\"tokenId\":\"436\",\"merchantReference\":\"merRef1656991803097\",\"amount\":30,\"parentOrderId\":5798}",
"signature": "uE0rOafPFAf6ILmLQ8/as7ItebeVMH1zqp7bbutzAbw2o1tRS/cL+XVjjAcTiFKHsUzc05CF63DfIhSQNcqKPYRQOjnFk+VqRoecJ9jnu4Ps6fwaHK+FOKCI8PVkkfiu9aLoCksdglYi4O+kG7bbNJ5QFvJyIbQjSr95/wSX9DIRNnJL80cWJtzHttT4apBXyN0ajzTKaZLtpzAuwaMZmixUjS4IS4+d2GIqtSKUL03/PzYNSqkZPvnZE5Sa/3w83fcdDukkLvXUCrOv4VZlHh5GWpNSkcuskmnIosfP0QEDFOnOGdCDtZbhBdQ/FbGbhbJm51MTXG3I1byOLPgddA=="
}

Response Parameters

ParameterTypeRequireDescription
responseCodeStringMPayment Gateway response code
messageStringMPayment Gateway response message
orderObjectM 
order.idNumberMOrder identifier
order.merchantIdNumberMMerchant identifier which own this order
order.merchantReferenceStringMYour reference for the order
order.currencyStringM3-Letters ISO currency code of the order
order.amountNumberMOrder amount
order.netAmountNumberMNet amount of the order
order.cardTypeStringMCard type of the order
order.emailStringMCustomer's email if provided
order.createTimeDatetimeMTimestamp when the order is created. Maintained by the Payment Gateway
order.updateTimeDatetimeMTimestamp when the order is last updated. Maintained by the Payment Gateway
order.statusStringMStatus of the order. Maintained by the Payment Gateway
order.recurringBooleanMFlags the order is a recurring order or not
transactionObjectM 
transaction.idNumberMTransaction identifier for the recurring transaction
transaction.merchantIdNumberMMerchant identifier which own this transaction
transaction.typeStringMTransaction type
transaction.amountStringMTransaction amount
transaction.statusStringMStatus of the transaction. Maintained by the Payment Gateway
transaction.maskedPanStringMMasked card number of the recurring transaction if supported by the payment method
transaction.stanStringMSystem trace audit number for the transaction

Example:

{
"responseCode": "0000",
"message": "Success",
"order": {
"id": 5803,
"merchantId": 3,
"merchantReference": "merRef1656991803097",
"currency": "USD",
"amount": 30,
"netAmount": 30,
"cardType": "VISA",
"createTime": "2022-07-05T03:30:03.709+00:00",
"updateTime": "2022-07-05T03:30:03.709+00:00",
"status": "SUCCESS",
"recurring": true
},
"transaction": {
"id": 3974,
"merchantId": 3,
"type": "SALE",
"amount": 30,
"currency": "USD",
"status": "SUCCESS",
"maskedPan": "470534XXXXXX8101",
"stan": "3974"
}
}