Welcome to Zuora Product Documentation

Explore our rich library of product information

Set up your client code for GoCardless one-time payment flows

Configure your client code to integrate Payment Pages 2.0, specifying parameters for authorization and invoice processing.

Follow the instructions in Integrate Payment Pages 2.0 . When rendering the Payment Page form, specify the following additional parameters in the Z.render function to support the use case of authorization amount processing or invoice processing .

Parameter

Applicable use case

Description

enableNewUX

Both

Required

Type: boolean

Default: false

true indicates that the support for GoCardless Instant Bank Pay and Verified Mandates payment flow is enabled.

If it is false or not specified, the support for GoCardless Verified Mandates and Instant Bank Pay payment flow is disabled.

Zuora's support for processing one-time and subsequent recurring payments on GoCardless is implemented based on GoCardless Instant Bank Pay and Verified Mandates. Hence, to implement one-time payment flows on GoCardless, enableNewUX must be true .

doPayment

Both

Required

Type: boolean

Default: false

true indicates that this is a one-time payment transaction. 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 one-time or recurring payment flows, doPayment must be true .

storePaymentMethod

Both

Type: boolean

Default: true

true indicates that the payment method will be stored in Zuora and will be 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.

paymentDescription

Both

Required

Type: string

The string will be displayed as the description in the subscription information section in the payment flow.

field_accountId

Both

Required

The payment method will be created for the specified account.

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

authorizationAmount

Authorization amount processing

Required for authorization amount processing

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

field_currency

Authorization amount processing

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

Invoice processing

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 = {
    enableNewUX:"true",
    doPayment:"true",
    storePaymentMethod:"false",
    paymentDescription:"First Payment",
    field_accountId:"testc0f87596f2f301759c29443622fa",
    authorizationAmount:"99",
    field_currency:"USD"
};

Here is an example for invoice processing.

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

Step 5. Implement callback response

See Advanced Integration of Payment Pages 2.0 for more information.