API Integration
To trigger automated emails to your end-customers, you must securely pass their contact information to the system at the time of the transaction.
📘 Before integrating, please raise a request with your Business Point of Contact (POC) to ensure the email notification feature is enabled for your account.
Implementation & Payload
You must include the customerDetails object within the request payload of any supported API. Here is the required JSON structure:
"customerDetails": {
"name": "John Doe",
"email": "[email protected]",
"phoneNumber": "9999999999"
}Validation & Error Handling
To ensure notifications are delivered successfully, the data provided in the customerDetails object must be accurate:
- Missing Information: If the
customerDetailsobject is omitted, or if theemailfield is missing from the payload, the automated customer email will not be triggered. - Invalid Formatting: The email address must follow a valid format (e.g.,
[email protected]). Passing invalid formatting may result in an API validation error or cause the email delivery to fail silently.
Supported APIs
Below is the list of endpoints and the specific notifications they trigger when the customerDetails object is included:
| Endpoint | Notification Triggered |
POST /subscriptions/v2/setup | Setup confirmation email |
POST /subscriptions/v2/notify | Feeds redemption flow |
POST /subscriptions/v2/redeem | Redemption success / failure email |
POST /subscriptions/v2/{id}/cancel | Cancellation email |
| POST /checkout/v2/pay | Autopay on Standard Checkout Setup |
POST /checkout/v2/subscriptions/notify | Feeds redemption flow |
POST /checkout/v2/subscriptions/redeem | Redemption success / failure email |
POST /checkout/v2/subscriptions/{id}/cancel | Cancellation email |
POST /checkout/v2/pay | Checkout payment notifications |
POST /checkout/v2/sdk/order | SDK order notifications |
POST /payments/v2/refund | Refund confirmation email |
POST /payments/v2/pay | Custom checkout pay UPI Intent, UPI QR, CARD, NetBanking, Token, EMI, Wallet |
POST /payments/v2/sdk/order | Custom SDK order notifications |
