Create payment methods on Planet

Last updated
Save as PDF

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

You can create Credit Card payment methods by using the REST API operations for creating payment methods, such as Create a payment method. In your request, pass in the following required fields.

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.
expirationMonth	integer	One or two-digit expiration month (1-12) of the credit card.
expirationYear	integer	Four-digit expiration year of the credit card.
tokens	object	The container for 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 `Planet` in this field. `tokenId` Type: string Specify the value of the alias field returned in the Datatrans response. `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",
    "expirationMonth": 6,
    "expirationYear": 2025,
    "cardMaskNumber": "***********1112",
    "tokens": {
        "gatewayType": "Planet",
        "tokenId": "7LHXscqwAAEAAAGOQajbRivpkJiWADOS"
    },
    "cardType": "Visa",
    "type": "CreditCard"
}

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

Related information