Skip to main content
Card Recurring

Under Construction​

By following this basic integration guide, you will understand how you can start accepting recurring card payments in India using EBANX Direct API.

How it works​

Content will go here.

Requirements​

  • API credentials - Ensure you have your EBANX integration key. If not, complete the Merchant Signup Form.
  • Familiarity with EBANX Direct - This setup follows the same general structure as other payment methods, with a few unique parameters.
  • Recurring Cards Enabled – Ensure that Recurring Cards is activated in your EBANX dashboard. If it is not enabled, contact your Integration Specialist for assistance.

Instructions​

Follow the steps below.


  1. Select your environment

    Select the appropriate environment for your integration. Use the sandbox environment for testing, or the production environment for live transactions. Use the URL for your HTTP requests based on your selection.

    https://sandbox.ebanx.com/ws/direct

  2. Configure your Notification URL

    For your Recurring Cards flow, webhook notifications will provide updates on subscription status changes (e.g., paused, revoked), pre-debit alerts to users, and payment transaction events. Upon receiving a webhook notification, you must query EBANX for the latest status.

    For setup details, refer to the Notifications Guide.

  3. Request a Subscription + First Charge

    Collect the necessary parameters to configure your request.

    ParameterDescription
    operationSet to enrollment
    integration_keyYour EBANX integration key
    payment_type_codeSet to creditcard or debitcard

    Customer information

    ParameterDescription
    namePayer full name
    emailCustomer email
    phone_numberCustomer phone number, in full international format
    addressStreet name, character limit 100
    street_numberStreet number, character limit 30
    street_complementComplement information, character limit 100
    cityAbbreviation (DL, JK, etc)
    stateAbbreviation (UP, HR, etc)
    zipcode6-digit zipcode

    Subscription details

    ParameterDescription
    enrollment.merchant_enrollment_codeUnique identifier associated with the subscription. (Character limit: 254)
    enrollment.countryTwo-letter country code. Set to in for India.
    subscription.subscription_nameDescription for the subscription.
    subscription.expiration_dateValidity for the subscription.
    subscription.frequencyFrequency rule for charging the subscription.
    Accepted values:
    daily weekly fortnightly monthly bimonthly quarterly halfyearly yearly ondemand
    subscription.min_amountMinimum amount (per charge) during the validity of the subscription plan, in INR. (Should start from INR 1)
    subscription.max_amountMaximum amount (per charge) during the validity of the subscription plan, in INR. (Max amount INR 100000)

    Charge parameters

    ParameterDescription
    payment.namePayer full name.
    payment.emailCustomer email.
    payment.countrySet to in for India.
    threeds_forceTrue
    payment.merchant_payment_codeUnique code for the payment.
    payment.currency_codeISO-4217 Currency code transaction. Supported value: INR.
    payment.merchant_payment_codeUnique code for the payment.
    payment.amount_totalCharge amount (Minimum 1.00 INR)
    payment.enrollment.merchant_enrollment_codeUnique identifier for the subscription, with a maximum character limit of 254.
    payment.enrollment.customer_notify_hashUnique identifier for the Pre-debit notification, returned as a hash in the response upon successful notification delivery.sent.
    Subscription Frequency Rules

    Pre-defined subscription.frequency values dictate when charges can be executed but do not automate subsequent actions. Pre-debit notifications and charge executions must still be managed. Attempts outside the schedule will be declined, but missed windows do not affect subscription status. Charges can proceed in the next cycle. For more flexibility, use ondemand as the frequency.

    Shared Subscription Details

    The values in subscription.subscription_name, subscription.expiration_date, and subscription.frequency will be sent to the user via SMS by their issuing bank.

    Fixed Subscription Amount

    To set a fixed amount for a subscription request, send subscription.min_amount and subscription.max_amount with the same value.

  4. Sample Request

    curl -X POST \
      --location 'https://sandbox.ebanx.com/ws/userenrollment' \ // Enrollment endpoint.
      --header 'Content-Type: application/json' \
      --data '{
        "integration_key": "********************************ebxlfe",
        "operation": "request",
        "mode": "full",
        "payment": {
            "name": "Sam",
            "email": "sam@xyz.com",
            "birth_date": "12/04/1979",
            "document": "EF5680710",
            "address": "Nirvana society",
            "street_number": "2993",
            "street_complement": "CJ 5",
            "city": "DL",
            "state": "DL",
            "zipcode": "110017",
            "country": "in",
            "phone_number": "4111111111",
            "payment_type_code": "creditcard",
            "instalments": "1",
            "amount_total": 1,
            "currency_code": "INR",
            "merchant_payment_code": "testmandate00101",
            "card": {
                "card_number": "13452******0495",
                "card_name": "Sam Sh",
                "card_due_date": "08/2050",
                "card_cvv": "***",
                "threeds_force": true
            },
            "enrollment": {
                "country": "in",
                "merchant_enrollment_code": "testenrollment00101",
                "email": "sam@xyz.com",
                "back_urls": {
                    "success": "https://developer.ebanx.com/",
                    "failure": "https://google.com.br"
                },
                "subscription": {
                    "subscription_name": "testsub00101",
                    "expiration_date": "2024-12-31",
                    "min_amount": "1",
                    "max_amount": "1000",
                    "frequency": "ondemand"
                }
            }
        }
    }

  5. Sample Response

    Content Here

  6. Pre debit notification to user

    Content Here

  7. Charge Subscription

    Content Here

  8. Create Payment

    Content Here

  9. Await notification

    Content Here

  10. Query enrollment

    Content Here

  11. Revoke an enrollment

    Content Here

  12. Congratulations!

    You have succesfully integrated Card Recurring.

    For more information, refer to the
    Direct API reference guidechevron_right

Resources​

Use the following resources when testing in your sandbox environment.

Globe Icon

API Reference

Click here to access detailed API documentation to integrate efficiently.

Click to explorechevron_right
Mock Data Icon

Mock Customer Data

Click here to view mock customer data for testing and validating user flows.

Click to explorechevron_right
Debit Card Icon

Error Codes

Click here to review common error codes to troubleshoot and resolve issues quickly.

Click to explorechevron_right

Still need help?

Help Image

We hope this article was helpful. If you still have questions, you can explore the following options: