Create payment methods on Windcave

Last updated
Save as PDF

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

To create Credit Card payment methods on Windcave, use one of the following approaches:

REST API approach
Hosted payment page approach
Zuora UI approach

REST API approach

You can create tokenized Credit Card payment methods through the Create a payment method API operation. Use one of the following options.

Option 1: Pass in the card number

In your request, pass in the following required fields. A token is generated when validating the payment method with the gateway. Both the card information and the token are stored for the payment method but 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.
cardNumber	string	The credit card number.
cardHolderInfo	object	The container for cardholder information. The nested `cardHolderName` field is required. Pass in the card holder's full name as it appears on the card, such as "Amy Lawrence", 50 characters or less.
cardType	string	The type of the credit card.
expirationMonth	integer	One or two-digit expiration month (1-12) of the credit card.
expirationYear	integer	Four-digit expiration year of the credit card.
type	string	The type of the payment method. Specify `CreditCard` in this field.
tokenize	boolean	default: false Specify `true` for this field to tokenize the payment method with the card number.

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

{
    "accountKey": "8a90d6128d45df2b018d4b90681c05x0",
    "cardHolderInfo": {
        "cardHolderName": "Amy Lawrence"
    },
    "cardNumber": "4111111111111111",
    "cardType": "Visa",
    "expirationMonth": 6,
    "expirationYear": 2025,
    "type": "CreditCard",
    "tokenize": true
}

For other optional fields, see Create a payment method.

Option 2: Pass in your existing token

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 `Windcave` in this field. `tokenId` Type: string Specify the value of `cardId`. `secondTokenId` Type: string Pass in the second token of the payment method if available. `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": "Windcave",
        "tokenId": "0000030002415853"
    },
    "type": "CreditCard"
}

For other optional fields, see Create a payment method.

Hosted payment page approach

You can implement a hosted payment page through the Payment Pages 2.0 solution to collect your customer’s payment method data and create the payment method in Zuora. When creating a payment method through the hosted payment page, a token is generated and stored for the payment method.

If you want to enable 3D Secure for your payment page, when setting up a hosted payment page, select the Enable 3D Secure 2.0 checkbox and select the Windcave gateway instance that you created from the Default Payment Gateway dropdown list.

For more information about the implementation of hosted payment pages, see Payment Pages 2.0 implementation overview.

Zuora UI approach

For more information on creating payment methods through the UI, see Set up the payment method through the Zuora UI. When creating payment methods through the UI, a token is generated and stored for the payment method.

Required configuration settings

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