Welcome to Zuora Product Documentation

Explore our rich library of product information

Overview of CardConnect gateway integration

The CardConnect gateway integration supports various payment methods, including credit cards, debit cards, and ACH, with features like tokenization and gateway options.

Supported payment methods

CardConnect gateway integration supports the following payment methods:

  • Credit Card/Gift Card/Prepaid Card:

    • Visa

    • Mastercard

    • American Express

    • Discover

    • JCB

    • Diners

  • Credit Card Reference Transactions Zuora supports CardConnect tokens for Visa, Mastercard, American Express, and Discover. Tokens are used for credit card reference transactions in Zuora. A reference transaction is simply a representation of a credit card payment method without having sensitive payment method information like the credit card number stored in Zuora. Please note that the token cannot be used with another gateway, which is why we recommend storing credit card information in Zuora whenever possible.

  • Debit Cards:

    • Visa

    • Mastercard

  • ACH ACH payment method verification is supported through the ValidiFi account validation service. See Enable the support for ValidiFi account validation for ACH for details.

Credit Card tokenization

To create tokenized Credit Card payment methods, use a REST API operation for creating payment methods, such as Create a payment method , and pass in the following required fields:

  • type

  • accountKey

  • cardMaskNumber

  • cardType

  • expirationMonth

  • expirationYear

  • tokens

    • gatewayType Specify CardConnect in this field.

    • tokenId Pass in the value of CardSecure Token .

Here is an example of the API request for creating a tokenized Credit Card payment method:

{
    "type": "CreditCard",
    "accountKey": "402880e790e9abb80190ef70a3720203",
    "cardMaskNumber": "***********1112",
    "expirationMonth": 6,
    "expirationYear": 2025,
    "cardType": "Visa",
    "tokens": {
        "gatewayType": "CardConnect",
        "tokenId": "9374462453058431"
    }
}

For other optional fields, see Create a payment method .

For tokenized payment methods, you must validate them in Zuora so that payments made with these payment methods are successful. To validate tokenized payment methods, enable the following settings on the gateway instance configuration page:

  • Verify new payment method

  • Verify updated payment method

Supported Gateway Options fields

You can submit additional information to the CardConnect gateway using gateway options. Currently, CardConnect supports the following gateway option field:

  • custommerchant (type: string)

You can use this field in Payment Pages 2.0 , SOAP API , or the following REST API.

  • Create a payment

  • Create a payment method

  • Refund a payment

  • CRUD: Create a payment method

  • CRUD: Create a payment

  • CRUD: Create refund

Set up and configure a CardConnect gateway instance