1. Features
Merchant Connect API
HASE
  • latest
  • HASE
  • Integration Guide
    • EC Payment
      • Merchant API
        • Overview
        • Payment
        • Payment Methods
        • After Payment
          • Capture
          • Cancel
          • Refund
          • Cancel or Refund
          • Accept Notification
        • Features
          • Account Status Inquiry (ASI)
          • COF
          • Recurring
          • Instalment
          • Authentication
            • 3D Secure
            • Authorization only
          • Tokenization
            • Gateway Tokenization
            • Create a gateway token
            • Network Tokenization
            • Pay with gateway token
            • Manage token
    • In-store Payment
      • Merchant API
        • Payment
          • CPM
          • MPM
          • MPM static QR code
        • After Payment
          • Capture
          • Cancel
          • Refund
          • Cancel or Refund
          • Accept Notification
  • API Explorer
    • API Rules
    • PaymentMethod
      • PaymentMethod
      • PaymentMethod
      • PaymentMethod
      • PaymentMethod
    • Payment
      • Payment
      • Payment
      • Payment
    • Capture
      • Capture
      • Capture
    • Cancel
      • Cancel
      • Cancel
    • Refund
      • Refund
      • Refund
    • Cryptogram
      • Cryptogram
      • Cryptogram
    • Cancel or Refund
      • Cancel or Refund
      • Cancel or Refund
    • Notification
      • Notification for PaymentMethod
      • Notification for Payment
      • Notification for Capture
      • Notification for Cancel
      • Notification for Refund
      • Notification for MPM Static QR Code
      • Notification for Token Status Update
      • Notification for Cryptogram
    • Appendix
      • Result Code
      • Payment Brands
      • Payment Method Variant
      • Currency list
      • Country and region list
    • HealthCheck
      • HealthCheck
    • TransactionHistoryInquiry
      • TransactionHistoryInquiry
    • Instalment
      • Instalment Plan Inquiry
HASE
  • latest
  • HASE
  1. Features

Recurring

It is only applicable to EC Scenario.
Recurring payments consist of two types of transactions: the initial (or first) recurring transaction and subsequent transactions.
Initial or First Recurring Transaction (Save Credentials)
The initial or first recurring transaction occurs when a cardholder purchases or agrees to receive a set of goods or services at an established frequency while transacting at a merchant's site (cardholder present). This transaction also indicates that the cardholder agrees with the merchant to save the credentials.
Subsequent Transactions
Subsequent transactions are where a merchant automatically charges a cardholder for specified goods or services that they have previously agreed to in the initial transaction, without having to re-engage the cardholder (cardholder not present) until the predefined or agreed-upon time frame (recurringExpiry) is reached.
These are the different types of recurring payments based on the certainty of the amount and frequency of the transactions:
1.
Fixed amount and fixed frequency
2.
Variable amount and variable frequency, Variable amount and fixed frequency or Fixed amount and variable frequency.

Save Credentials#

EVO Cloud requires that credentials be saved first when processing recurring payments. You can use two methods:
1.
Merchant Saved Credentials: If you have submitted and completed the PCI DSS Self-Assessment Questionnaire D (SAQ D), you can save card information and use it for further payments.
2.
Gateway Tokenization: See the chapter on Gateway Tokenization for more details.

Merchant saved credentials#

From your server, you can make an HTTP POST request to EVO Cloud endpoint
/g2/v1/payment/mer/{sid}/payment
and specify the additional parameters below.
ParameterRequiredDescription
paymentMethod.recurringProcessingModelOThis indicates whether the transaction is a recurring transaction.
Subscription: Making a recurring payment with a fixed amount and fixed frequency.
Unscheduled: Making a recurring payment with a variable amount and variable frequency, variable amount and fixed frequency, or fixed amount and variable frequency.
captureAfterHoursOThe number of hours for EVO Cloud to initiate Capture on behalf of the merchant after successful payment. For recurring transactions, set this to 0; EVO Cloud will initiate Capture immediately after successful payment.
transAmountMThe currency and value of the payment. The value must follow the currency's minor unit.
You need to include additional parameters in your payment request if you are:
1.
Card Information: See the additional parameters in the paymentMethod.card object.
2.
Authenticating the User: Use 3D Secure or SecurePlus. See the chapter on Authentication for more details.
EVO Cloud allows ASI (zero payment amount in the transAmount object) or authorization with an amount to complete saving credentials.
If the payment is successful, you will receive paymentMethod.recurringReference in the response. You will use this reference for subsequent transactions.
If you do not receive paymentMethod.recurringReference in the response, you can retrieve the payment result. See the chapter on Payment for more details.

Subsequent Transactions#

From your server, you can make an HTTP POST request to EVO Cloud endpoint
/g2/v1/payment/mer/{sid}/payment
and specify the additional parameters below.
ParameterRequiredDescription
paymentMethod.recurringProcessingModelOThis indicates whether the transaction is a recurring transaction.
Subscription: Making a recurring payment with a fixed amount and fixed frequency.
Unscheduled: Making a recurring payment with a variable amount and variable frequency, variable amount and fixed frequency, or fixed amount and variable frequency.
paymentMethod.recurringReferenceOThe recurringReference that uniquely identifies the recurring transaction. The merchant will need this to make future payments for the user.
captureAfterHoursOThe number of hours for EVO Cloud to initiate Capture on behalf of the merchant after successful payment. For recurring transactions, set this to 0; EVO Cloud will initiate Capture immediately after successful payment.
transAmountMThe currency and value of the payment. The value must follow the currency's minor unit.
If you use ASI to save credentials, the first subsequent transactions may also require authentication. See chapter* Authentication* for more details.
Previous
COF
Next
Instalment
Built with