Welcome to Zuora Product Documentation

Explore our rich library of product information

Supported payment methods

The following sections provide additional information for each supported payment method type.

For more information about the supported currencies, see Supported currencies by gateways.

For more information about setting up payment methods in Zuora, see Define and set up payment methods.

Credit Card Reference Transaction

Tokens are used for credit card reference transactions in Zuora. A reference transaction represents a credit card payment method without storing sensitive credit card information in Zuora. Zuora supports Stripe tokens. The token cannot be used with another gateway, so storing credit card information in Zuora is recommended whenever possible.

For Credit Card Reference Transaction (CC Ref) payment methods created through the UI or API operation, only existing Stripe tokens are supported. Creating tokens in Zuora is not supported. For CC Ref payment methods created on Stripe v2 through the hosted payment page, tokens will be generated by Zuora.

Complete the following prerequisites for processing credit card reference transactions:

  1. Enable the Credit Card Reference Transaction payment method in Zuora:
    1. Click your username on the upper right.
    2. Navigate to Settings > Payments > Payment Method. The Customize Payment Methods page opens.
    3. Click Edit and select CC Reference Transaction.
  2. Contact Zuora Global Support to enable the Payment Tokenization feature for your tenant.

Zuora validates the format of both required fields when setting up a Credit Card Reference Transaction payment method on Stripe:

Token ID. Acceptable values:

  • Stripe Payment Method ID starting with pm_ (Stripe v2 only)
  • Stripe Bank Account ID starting with ba_
  • Stripe Card ID starting with card_
  • Stripe Source ID starting with src_

Second Token ID. The value must be the Stripe Customer ID (starting with cus_).For more information about the Stripe token object, see Stripe documentation.

Credit Card Tokenization

Note:

To enable tokenizing credit card payment methods on Stripe Integration v2, submit a request at Zuora Global Support

To create tokenized credit card payment methods, use one of the following approaches.

The following table describes the token field mappings:

Stripe FieldZuora Field
Stripe Customer Id (e.g., cus_xxxxxxxx)tokens > tokenId
Stripe Payment Method Id (e.g., pm_xxxxxxxx)tokens > secondTokenId

Approaches to creating tokenized credit card payment methods:

ApproachDescriptionExample
Use Create a payment method API operation to tokenize PAN data

Pass in the following required account information and set tokenize to true:

  • Type

  • Card Type

  • Card Number

  • Expiration Month

  • Expiration Year

Tokens are generated and stored in Zuora, and used in the subsequent recurring payments.

 },
  "cardNumber": "378282246310005",
  "cardType": "Visa",
  "type": "CreditCard",
  "expirationMonth": "03",
  "expirationYear": "2030",
  "securityCode": "7377",
  "type": "CreditCard",
  "tokenize": true
}

Use an API operation that supports payment method creation, such as Create a payment method, to pass in existing tokens

Pass in the following required fields:

  • Type

  • Card Type

  • Card Mask Number

  • Gateway Type

Pass in Customer Id through tokens>tokenId.

Pass in Payment Method Id through tokens>secondTokenId.

Tokens are stored in Zuora and used in subsequent payments.


{
"cardType": "Visa",
"cardMaskNumber": "37828XXXX310005",
"type": "CreditCard",
"tokens": {
"tokenId" : "cus_SD********PiCO",
"secondTokenId" : "pm_1RJ*****************bKiM",
"gatewayType": "Stripe"
}
}

 
                            
Use an API operation that supports payment method creation, such as Create a payment method, to pass in existing tokens and card information.

Pass in the following required fields:

  • Type

  • Card Type

  • Card Number

  • Expiration Month

  • Expiration Year

  • Gateway Type

Pass in Customer Id through tokens>tokenId.

Pass in Payment Method Id through tokens>secondTokenId.

Tokens are stored in Zuora and used in subsequent payments.

{
  "cardNumber": "378282246310005",
  "cardType": "Visa",
  "cardMaskNumber": "37828XXXX310005",
  "expirationMonth": "03",
  "expirationYear": "2030",
  "securityCode": "7377",
  "type": "CreditCard",
  "tokens": {
    "tokenId" : "cus_SD********PiCO",
    "secondTokenId": "pm_1RJ*****************bKiM",
    "gatewayType": "Stripe"
  }
}

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