Required Parameters for UPI Intent with the Adyen Gateway Integration

This document outlines the required parameters for payment processing, including field specifications, default values, and usage instructions for Zuora and Adyen integration.


Required Parameter	Description
`field_upiTimerWindow`	Type: integer. Default: 36. Min: 5. Max: 36. The timer window allows end customers to complete the payment. By default, this window is set to 5 minutes. Once the timer expires, the timer dialog closes. It then takes up to an additional two minutes to retrieve the latest payment status information from Adyen.
`doPayment`	Type: boolean. Default: false. `true` indicates that the Payment Page creates a payment method and also processes the one-time payment transaction. `false` indicates that the Payment Page creates only a payment method. To implement payment processing flows, set `doPayment` to `true`. To implement payment method validation and setup flows, set `doPayment` to `false`.
`storePaymentMethod`	Type: boolean. Default: true. `true` indicates that the payment method is stored in Zuora and used in subsequent recurring payments. `false` indicates that the payment method is not stored in Zuora. End customers need to be brought back on session to authenticate the payment.
`field_accountId`	Type: string. Example: `8a90e5e48f2eade6018f2ed19133003a`. Zuora customer account ID. This account must be set up with the INR currency. The payment method is created for this specified account.
`authorizationAmount`	Required for authorization amount processing. For payment processing flows, this is the amount of the one-time payment sent to the gateway. For payment method validation flows, specify `0` for this field.
`field_currency`	Required for authorization amount processing. The currency of the one-time payment amount. Only INR is supported by Adyen UPI.
`documents`	Required for invoice processing. An array of invoices to be paid in this transaction, containing `type` and `ref` fields. The `type` value must be `invoice`, and the `ref` value must be the invoice number, such as `INV0000001`.
`param_gwOptions_UpiMandateEnabled`	Type: boolean. Default: false. To create a mandate and store the payment method in Zuora for processing subsequent recurring payments, specify `true`. Otherwise, specify `false`.
`param_gwOptions_UpiMandateAmount`	See `mandate.amount` in Adyen documentation.
`param_gwOptions_UpiMandateAmountRule`	Default: `max`. See `mandate.amountRule` in Adyen documentation.
`param_gwOptions_UpiMandateFrequency`	Default: `adhoc`. See `mandate.frequency` in Adyen documentation.
`param_gwOptions_UpiMandateStartsAt`	See `mandate.startsAt` in Adyen documentation.
`param_gwOptions_UpiMandateEndsAt`	See `mandate.endsAt` in Adyen documentation.
`param_gwOptions_UpiMandateRemarks`	The mandate message passed to the end customer. Shoppers see this message when they open the notification. See `mandate.remarks` in Adyen documentation.
`param_gwOptions_UpiMandateBillingAttemptsRule`	Default: `after`. See `mandate.billingAttemptsRule` in Adyen documentation.
`param_gwOptions_UpiMandateBillingDay`	Default: `1`. See `mandate.billingDay` in Adyen documentation.
`param_gwOptions_additionalAmount`	If you want to use a non-zero value in a payment method verification request, pass the `param_gwOptions_additionalAmount` Gateway Options field. It is mapped to Adyen's `additionalAmount.value` field and sent to Adyen.

Use the parameter combinations according to your target flow:

For a one-time payment, set doPayment = true and pass a non-zero authorizationAmount.
For payment method setup without an immediate charge, set doPayment = false and authorizationAmount = 0.
For mandate creation and recurring payment support, set storePaymentMethod = true and param_gwOptions_UpiMandateEnabled = true.

For more detailed information, see Adyen's documentation for more information.

Welcome to Zuora Product Documentation

Explore our rich library of product information

Required Parameters for UPI Intent with the Adyen Gateway Integration

zuora-footer