Welcome to Zuora Product Documentation

Explore our rich library of product information

Required parameters

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 36 minutes. To modify the minimum and maximum limits, submit a request at Zuora Global Support .

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 will create a payment method as well as process the one-time payment transaction.

If it is false or not specified, the Payment Page will only create 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 will be stored in Zuora and used in subsequent recurring payments.

false indicates that the payment method will not be 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 will be created for this specified account.

authorizationAmount

Required for authorization amount processing

For payment processing flow, it is the amount of the one-time payment that will be sent to the gateway.

For payment method validation flow, specify 0 for this field.

For more information about this parameter, see Client parameters for Payment Pages 2.0 .

field_currency

Required for authorization amount processing

The currency of the one-time payment amount. Only INR is supported by Adyen UPI.

For more information about this parameter, see Client parameters for Payment Pages 2.0 .

documents

Required for invoice processing

An array of invoices to be paid in this transaction, containing the following fields:

  • type - The value must be invoice .

  • ref - The 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 . The payment method will not be stored in Zuora. End-customers need to be brought back on session to authenticate the payment.

param_gwOptions_UpiMandateAmount

See mandate.amount in Adyen's documentation.

param_gwOptions_UpiMandateAmountRule

Default: max

See mandate.amountRule in Adyen's documentation.

param_gwOptions_UpiMandateFrequency

Default: adhoc

See mandate.frequency in Adyen's documentation.

param_gwOptions_UpiMandateStartsAt

See mandate.startsAt in Adyen's documentation.

param_gwOptions_UpiMandateEndsAt

See mandate.endsAt in Adyen's documentation.

param_gwOptions_UpiMandateRemarks

The mandate message that will be passed to the end customer.

The shoppers see this message when they open the notification.

See mandate.remarks in Adyen's documentation.

param_gwOptions_UpiMandateBillingAttemptsRule

Default: after

See mandate.billingAttemptsRule in Adyen's documentation.

param_gwOptions_UpiMandateBillingDay

Default: 1

See mandate.billingDay in Adyen's documentation.

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. See Adyen's documentation for more information.