Migrate an existing payment method

Knowledge Center > Billing and Payments > Payment Operations > Stored credential transactions > Configuration procedures > Migrate an existing payment method

Migrate an existing payment method

Before enabling stored credential transactions for an existing payment method, ensure that the customer has given consent for their payment credentials to be stored on file.

How to enable stored credential transactions for an existing payment method depends on whether the payment gateway supports merchant-initiated stored credential transactions (MITs) without transaction IDs:

  • MITs without transaction IDs are supported

    If the payment gateway supports MITs without transaction IDs, for example, Chase Paymentech Orbital Gateway, you should create an Agreed stored credential profile within the payment method. You can create an Agreed stored credential profile through the REST API (see below).

    When you create the Agreed stored credential profile, Zuora does not immediately validate the stored credentials with the payment gateway.

    Instead, Zuora validates the stored credentials by sending a merchant-initiated transaction to the payment gateway when the payment method is next used in a payment. The status of the stored credential profile changes to Active at this point, provided the payment succeeds. If the payment does not succeed, the stored credential profile remains in the Agreed status.

  • MITs without transaction IDs are not supported

    If the payment gateway supports stored credential transactions, but does not support MITs without transaction IDs, you should create an Active stored credential profile within the payment method. You can create an Active stored credential profile through the REST API or Zuora UI (see below).

When you create the Active stored credential profile, Zuora immediately validates the stored credentials with the payment gateway. Zuora validates the stored credentials by sending a cardholder-initiated transaction (CIT) to the payment gateway.

If the payment gateway does not support stored credential transactions, it does not matter whether you create an Agreed stored credential profile or an Active stored credential profile. In either case, Zuora sets the status of the stored credential profile to Agreed.

To learn more about the differences between Active and Agreed stored credential profiles, see Payments and Payment Runs.

Create an Agreed stored credential profile through REST API

To create an Agreed stored credential profile through the REST API, use the Create stored credential profile operation with the following request body:

  {
    "consentAgreementSrc": "External",
    "status": "Agreed",
    "type": "Recurring"
  }

You can also set the consentAgreementRef field if you want to provide your reference for the consent agreement that you have established with the customer.

Create an Active stored credential profile through REST API

To create an Active stored credential profile through the REST API, use the Create stored credential profile operation with the following request body:

  {
    "consentAgreementSrc": "External",
    "status": "Active",
    "type": "Recurring"
  }

You can also set the consentAgreementRef field if you want to provide your reference for the consent agreement that you have established with the customer.

Create an Active stored credential profile through the Zuora UI

To create an Active stored credential profile through the Zuora UI:

  1. Locate the payment method in the Electronic Payment Methods section of the customer account, then click add profile. A dialog opens:
     Add profile confirmation
  2. Select End user consent agreement received and optionally enter the card security code in Card Security Code
  3. Click confirm.

What's next

You can view the stored credential profile after migrating an existing payment method in Zuora.

Last modified

Tags

This page has no custom tags.

Classifications

(not set)