Welcome to Zuora Product Documentation

Explore our rich library of product information

Create payment methods on FiservIPG using REST API approach

Learn how to create tokenized Credit Card payment methods on Fiserv IPG using the REST API approach, including required fields and example API requests.

Note:

This payment gateway integration can be requested through the Specialized Payment Connections service at an additional cost.

You can use the REST API approach to create Credit Card payment methods on Fiserv IPG. You can create tokenized Credit Card payment methods through the Create a payment method API operation. To create a Credit Card payment on Fiserv IPG:

In your request, pass in the following required fields. A Credit Card payment method is created by using the provided token, and the token is used in processing subsequent payment transactions.

Required Field

Type

Description

accountKey

string

Zuora internal ID of the customer account that will own the payment method.

cardMaskNumber

string

The masked card number.

cardType

string

The type of the credit card.

tokens

object

The container of the token information. Pass in your existing token information through the following nested fields in this container:

  • gatewayType Type: string The type of payment gateway to generate the token. This field is case-sensitive. Specify FiservIPG in this field.

  • tokenId Type: string Specify the value of BillKey, which is the token shared by the gateway for the card. Note that this field is mandatory and must be sent via the API.

  • secondTokenId Type: string Specify the value of the CustomerID, which is shared by the gateway when tokenizing the credit card. Note that this field is mandatory and must be sent via the API.

  • thirdTokenId Type: string Pass in the third token of the payment method if available.

type

string

The type of the payment method. Specify CreditCard in this field.

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

{
    "accountKey": "8a90d6128d45df2b018d4b90681c05x0",
    "cardType": "Visa",
    "cardMaskNumber": "************1111",
    "tokens": {
        "gatewayType": "FiservIPG",
        "tokenId": "0000030002415853",
        "secondtokenID": "0000030002485856"
    },
    "type": "CreditCard"
}

For other optional fields, see Create a payment method .