Skip to main content

Introduction

A card subscription collects recurring payments against the buyer’s card. You register the card once with a standing instruction (SI), the buyer authenticates the mandate, and every debit after that is authorised by it.

Create Subscription

Create a card subscription order with a standing instruction

3D Secure Auth

Complete 3D Secure authentication for the card mandate
Collection is only half the flow. The mandate payment and every recurring debit are money collected in India — they are not yet cleared to settle abroad. Each one still needs its compliance details asserted before it can settle. See Collection Overview.

Prerequisites

Before you begin, ensure you have:
  • Credentials: Your X-Client-ID and X-Client-Secret, and X-API-Version: 3.0.0 on every call
  • Domain Whitelist: Your website domain whitelisted for integration
  • Webhook URL: A secure endpoint to receive payment and subscription status updates
  • Card subscription enablement: Card recurring subscriptions enabled and approved by EximPe on your account
  • Server environment: The ability to make HTTPS POST and GET requests from your backend
PSP callers additionally send X-Merchant-ID naming the sub-merchant the subscription belongs to.
Card details reach EximPe from your server, not the browser. This is a server-to-server call, so the card number passes through your systems — you are in PCI scope for it. If you would rather not be, take the subscription over UPI Intent instead, where no card data touches you.
Examples on this page use the sandbox host https://api-pacb-uat.eximpe.com. In production, use https://api-pacb.eximpe.com.

Step 1: Create the subscription

Call this from your backend. The request looks like a Create Order request with two additions: a standing_instruction block saying how much to bill and how often, and card_details for the card the mandate is registered against.
cURL

Response

Keep the subscription_id. Every call on the Manage Subscriptions page is addressed by it. For the full request and response schema, see Create Card Subscription.

Step 2: Complete 3D Secure authentication

Card mandates usually require 3D Secure authentication. If the response carries an acstemplate, it is a base64-encoded HTML form: decode it and render it on the client so the buyer can authenticate with their bank. The mandate becomes active only after that completes.
No acstemplate in the response means no 3D Secure step was required for that card. Move straight to confirming the mandate.

Step 3: Confirm the mandate is active

A created subscription is not yet a live mandate. Check with Get Subscription Mandate Status before you rely on it, and watch the Subscription Status webhook for the PENDINGACTIVE transition.

Step 4: Assert compliance on each payment

Every debit the mandate authorises is a payment collected in India, created in Action Required until you supply the compliance details its purpose code requires. Only then does it become eligible for settlement abroad.

Collection Overview

What a payment needs after it is collected, and how it reaches you abroad.

Next Steps

Once the subscription exists, go to Manage Subscriptions to check mandate status, modify or cancel the mandate, trigger adhoc charges, and view payment history. For the full request and response schema, see Create Card Subscription.