Execute API
Trigger scheduled or one-time payments against active mandates. Merchants can debit customer accounts for the authorized amount and frequency, handling periodic billing or on-demand charges. Supports detailed transaction scheduling and UPI-specific notification flows.
https://payments.airpay.co.in/pay/v4/api/mandates/execute.phpHeader
Section titled “Header”| Parameter | Type Value | Description | Value Like |
|---|---|---|---|
| Content-Type required | String | The Content-Type header specifies the media type of the request or response body, allowing the receiver to correctly interpret the For XML data, use application/xml. | For JSON: application/json,For XML: application/xml |
Request Body
Section titled “Request Body”| Parameter | Type Value | Description | Value Like |
|---|---|---|---|
| subscription_id required | Numeric (1–10) | Unique identifier assigned to the subscription or mandate. | |
| orderid required | Alphanumeric (10-200) | Unique order reference associated with the transaction. | |
| amount required | Numeric (1–10) | Transaction amount to be executed under the mandate. | |
| notification_id optional | Alphanumeric | Required only in case of UPI transactions and after 5 minutes of mandate creation. | |
| execution_time required | Alphanumeric (Date (dd/mm/yyyy)) | Scheduled execution date for the transaction or subscription debit. For UPI execution_time should current date. For eNACH execution_time should be greater than current date. |
Success 200
Section titled “Success 200”| Parameter | Type Value | Description | Value Like |
|---|---|---|---|
| merchant_id required | Numeric | Unique identifier assigned to the merchant. | |
| orderid required | Alphanumeric ( 10-200) | Unique order reference number for the transaction. | |
| ap_transactionid required | Numeric | Transaction ID assigned by the payment gateway. | |
| amount required | Numeric | Transaction amount. | |
| transaction_status required | Numeric | Status code representing the transaction result. | 211 = InProcess, 400 = Failed |
| transaction_payment_status required | String | Status text representing the payment state. | INPROCESS, SUCCESS, FAILED |
| message required | String | Status message describing transaction result or reason. | |
| transaction_type required | String | Defines the type of transaction. | sale, refund, mandate, etc. |
| transaction_time required | String ( DateTime (dd-mm-yyyy HH:MM:SS)) | Timestamp of the transaction event. | |
| customer_vpa optional | Alphanumeric | Required only in case of channel = UPI Customer’s Virtual Payment Address (applicable for UPI). |