Skip to main content

Set up and configure a Planet payment gateway instance

Zuora

Set up and configure a Planet payment gateway instance

  1. Last updated
  2. Save as PDF

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

Set up and configure a Planet gateway instance by using the information in this article, including prerequisites, configuration procedure, descriptions of the configuration fields and additional metadata, and reference for testing the payment gateway.

Prerequisites

Make sure you have requested support for Planet payment gateway integrations through the Specialized Payment Connections service.

Procedure

Complete the following steps to set up and configure a Planet payment gateway instance:

  1. Click your username in the upper right and navigate to Settings > Payments > Setup Payment Gateway. 
  2. On the Configure Gateway Instance tab, select Planet from the Gateway Type drop-down list.
  3. Click Create Gateway.
  4. On the gateway settings page, specify values for the configuration fields. See the following Configuration fields section for more information on the fields.
  5. Click Save Gateway Information.

Configuration fields

Basic Information

  • Name: Specify a name for the gateway instance.
  • Use Gateway Test Environment: When setting up the payment gateway integration, if you want Zuora to use the payment gateway's test service URL, select this checkbox.

Credentials

The following credentials provided by Planet must be configured. When a merchant account is set up with the Planet Datatrans gateway, the following information is assigned by the gateway. The information is used to identify the account through which the transaction will be processed.

  • MerchantId
  • Password

Rules

  • Cards Accepted: Select the cards you want to accept. Make sure your gateway's merchant account is also configured to support the same cards you have configured in Zuora. If you submit a transaction for a card type that is not enabled in your merchant account, it will result in an error stating the CardType is not supported or that you are not signed up for that tender type.
  • Default Authorization Amount: The authorization amount is not utilized in payment method validation on the Planet payment gateway integration, so this field does not take any effect. You can proceed by retaining the default value without further modification. 
  • Verify new payment method: Select this checkbox to verify the payment methods when creating them. By default, this checkbox is selected. For tokenized payment methods, you must validate them in Zuora so that payments made with these payment methods are successful.
  • Verify updated payment method: Select this checkbox to verify the payment methods when updating them. By default, this checkbox is selected. For tokenized payment methods, you must validate them in Zuora so that payments made with these payment methods are successful.

Test the configuration

We recommend that you test your payment gateway using both your payment gateway's test and production (live) environments.  Once you have completed testing in the gateway's test environment, it is recommended that you perform a test in your live production environment with a real credit card. If there are any differences in the configuration of your testing and production accounts, testing in production ensures your production merchant account is set up properly and can successfully connect to the production environment.

You can use the test information and testing scenarios provided by Planet to test your integration. For more information, see Datatrans documentation.