Skip to main content

Configuration procedures

Zuora

Configuration procedures

  1. Last updated
  2. Save as PDF

To help you ramp up on stored credential transactions and understand how the Stored Credential Transaction framework affect your experience in Zuora, the instructions to accommodate this framework are provided.

Instructions for new Zuora Payments users

If you are new to Zuora Payments, complete the following tasks to be compliant with the Stored Credential Transaction framework:

  1. Create a new payment gateway instance. See Payment gateways for the list of gateways that support stored credential transactions.
  2. Create a customer account if you have not created yet.
  3. Import payment methods if you intend to import payment methods from external systems into Zuora.
  4. Collect or create payment methods in Zuora. You can use Payment Pages to collect end customers’ payment method information, or use API or Zuora UI to create payment methods. 

Instructions for existing Zuora Payments users

If you have already been using Zuora Payments, take the following steps to be compliant with the Stored Credential Transaction framework:

  1. Check if the gateway integration you are using supports stored credential transactions. See Payment gateways for the list of gateways that support stored credential transactions.
    • If your current gateway instance supports stored credential transactions, proceed to the next step.
    • If your current gateway instance does not support stored credential transactions but a later version of the gateway integration does, create a new payment gateway instance of a later gateway version. Contact Zuora Global Support if you require additional assistance.
    • If your gateway does not support stored credential transactions yet, you can still create stored credential profiles using UI or API for your existing payment methods. The status of the profiles will be saved as Agreed and will be updated to Active when the gateway starts to support stored credential transactions.
  2. Import payment methods if you intend to import payment methods from external systems into Zuora.
  3. If you are using Payment Pages to collect end customers’ payment methods, use either of the following approaches. These approaches are not available for Apple Pay.
    • Modify your Hosted Payment Pages to include a way for customers to give consent for their payment credentials to be stored on file. 
    • Submit a request at Zuora Global Support to enable creating stored credential profiles automatically for payment methods added through Payment Pages 2.0. Stored credential profiles will be automatically created for all payment methods added through Payment Pages, regardless of whether the payment method is authenticated with 3D Secure 2.0. If you want to disable this feature, submit a request at Zuora Global Support.
  4. Create a stored credential profile within existing payment methods in Zuora. See Migrate an existing payment method or Migrate all existing payment methods for more information.

View the stored credential profiles 

You can view the stored credential profile through the Zuora UI or API. See the following articles for more information:

Configure using NTI in different types of transactions 

You can configure using the network transaction ID in different types of transactions. See Configure using NTI in different types of transactions for more information.

The network transaction IDs can be retrieved from the Response String field of the Payment Method Transaction Log data source.

Payment processing 

The subsequent payments using these payment methods will be considered as recurring or unscheduled stored credential transactions if the gateway supports the Stored Credential Transactions framework. See Stored credential profiles in payments and payment runs to learn how payments will be processed by the gateway.