Using Z-Payments Page with Zuora

Overview

There are two ways to associate a payment method created by Z-Payments Page with an account in Zuora:

• Use the Subscribe call to link a payment method to a newly created Zuora account
• Add a newly created payment method to an exisiting Zuora account

This section describe more detail on how to implement both of these options.

Using the Payment Method in a Subscribe API Call

The RefId returned from a successful Z-Payments Page submission is the same as the payment method ID (PM ID). Enter this ID for the payment method object in a subscribe() call when you create a new subscription.  

For example within the subscribe call you would enter:

<ns1:PaymentMethod>
   <ns2:Id>[RefID returned from Zuora]</ns2:Id>
</ns1:PaymentMethod>

How Zuora uses the ID depends on whether you are calling subscribe() on a new or existing account:

• For a new account, if you pass in a payment method (PM) ID, Zuora will associate the newly created account with this PM ID. This PM will be set as the default for the account and therefore be used for subsequent payments on the accont.
• For an existing account, if you pass in a PM ID, Zuora will associate the PM with the account and it will be used for this payment.  However, this PM will not be set as the default for the account, so the newly created PM will not be applied to subsequent payments.

Using the subscribe call is the only way to link a Z-Payments Page payment method to a newly created Zuora account.  You cannot create a payment method with Z-Payments Page and then update the AccountID in the payment method object via the API -- this is not an allowable function in Zuora.

If the PM ID is not submitted in the subscribe call or the ID is invalid, Zuora will attempt to validate that the rest of the fields are available (including credit card number and cardholder name) to create a payment method in the call.

Creating a Payment Method for an Existing Account

To create or add a payment method to an existing account, append the field accountId (along with the prefix 'field_')to the iFrame request. See Customizing Z-Payment Page for information about preloading data.

For example, To add a payment method to the accountId: 4028e69633f7e23b0133fc473bf141a5, you would append the following to the Z-Payments Page URL request:

&field_accountId=4028e69633f7e23b0133fc473bf141a5

The newly created payment method will not be made default on the account.  You will need to use the Zuora API to update the account to set this payment method as default.

Important: You must use the Zuora API to update card expiration dates and retrieve, display, and delete credit card information.

Related