APIs used in Offers Integration
The following APIs support recurring-payment consent, charging, and mandate management for Cards, Net Banking, and UPI.
Consent and recurring payment lifecycle
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Payment Consent Transaction using PayU Hosted Checkout | POST /_payment | Register a customer's recurring-payment consent through PayU Hosted Checkout. |
| Payment Consent Transaction with Merchant Hosted Checkout | POST /_payment | Register a customer's recurring-payment consent through a merchant-hosted Cards, Net Banking, or UPI checkout. |
| UPI Recurring Payment Consent Transaction | POST /_payment | Register a UPI recurring-payment mandate through Merchant Hosted Checkout. |
| Pre-Debit Notification API | pre_debit_SI | Notify the customer at least 48 hours before an upcoming recurring debit. |
| Recurring Payment Transaction API | si_transaction | Charge a successfully registered Cards, Net Banking, or UPI mandate through the recurring interface. |
| Cancel the Recurring Payment for Cards | mandate_revoke | Revoke a card mandate so that it can no longer be used for recurring payments. |
| Cancel the Recurring Payment for UPI | upi_mandate_revoke | Revoke a UPI mandate so that it can no longer be used for recurring payments. |
Experience the end-to-end PayU Hosted > Subscriptions flow and instantly generate the complete code for seamless, zero-coding integration into your website.
After a registration is canceled for a customer, the merchant cannot restore it, and the customer must register a fresh mandate with the merchant.
Manage Recurring Payment for Cards
The following sections describe how to cancel or modify the recurring payment for cards:
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Check Mandate Status API | check_mandate_status | Retrieve the current state of a card mandate. |
| Modify the Recurring Payments for a Card | POST /_payment | Update the billing details for an existing Visa or Mastercard recurring-payment mandate after customer authentication. |
| Cancel the Recurring Payment for Cards | mandate_revoke | Revoke a card mandate so that the customer must register a new mandate to resume recurring payments. |
Manage Recurring Payment for Net Banking
The following sections describe how to check or cancel the recurring payment for Net Banking:
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Cancel the Recurring Payment for Net Banking | mandate_revoke | Revoke a Net Banking mandate so that it can no longer be used for recurring payments. |
| Check the Net Banking Mandate Status API | NB_mandate_status | Retrieve the current state of an e-NACH mandate. |
Manage Recurring Payment for UPI
The following API commands are applicable only for UPI:
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Get Mandate Status API (for UPI only) | upi_mandate_status | Retrieve the current state of a UPI mandate, including mandates paused outside the merchant's system. |
| Modify the Recurring Payment for UPI | upi_mandate_modify | Modify an existing UPI recurring-payment registration. |
| Cancel the Recurring Payment for UPI | upi_mandate_revoke | Revoke an existing UPI recurring-payment registration. |
Handle Guest Checkout Transaction: You can handle Guest Checkout transactions for EMI integration. For more information, refer to Cards Integration > Handling Guest Checkout Transactions.
Updated 20 days ago