Welcome to Zuora Product Documentation

Explore our rich library of product information

Set up your client code

Learn how to set up your client code for Payment Pages 2.0 by specifying required parameters in the Z.render or Z.renderWithErrorHandler function.

Follow the instructions in Integrate Payment Pages 2.0 . When rendering the Payment Page form, specify the following required parameters in the Z.render or Z.renderWithErrorHandler function. For other optional parameters, see Client Parameters for Payment Pages 2.0 .

Required Parameter

Type

Description

doPayment

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. There will be an ad-hoc payment of 0.01 EUR and this amount will be automatically refunded by Stripe.

To implement one-time flows, doPayment must be true .

storePaymentMethod

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 to session to authenticate the payment.

field_accountId

string

Example: 8a90e5e48f2eade6018f2ed19133003a

Zuora customer account ID. The payment method will be created for this specified account.

authorizationAmount

number

Required for authorization amount processing

The amount of the one-time payment that will be sent to the gateway.

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

field_currency

string

Required for authorization amount processing

The currency of the one-time payment amount.

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

documents

array

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 .

Here is an example for authorization amount processing:

var params = {
    doPayment:"true",
    storePaymentMethod:"true",
    paymentDescription:"First Payment",
    field_accountId:"testc0f87596f2f301759c29443622fa",
    authorizationAmount:"99",
    field_currency:"EUR"
};

Here is an example for invoice processing:

var params = {
    doPayment:"true",
    storePaymentMethod:"true",
    paymentDescription:"First Payment",
    field_accountId:"testc0f87596f2f301759c29443622fa",
    documents:"[{\"type\": \"invoice\", \"ref\": \"INV0000001\"}, {\"type\": \"invoice\", \"ref\": \"INV0000002\"}]"
};