home

Zuora Payments

Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies
Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies

Welcome to Zuora Product Documentation

Explore our rich library of product information

Show Contents

thumbnailZuora Payments

Planet Payment Gateway Integration

Configuration fields for Planet Datatrans Payment Gateway Integration

This task provides instructions for configuring a Planet Datatrans gateway instance, including setting up credentials, selecting accepted cards, and defining customized metadata for enhanced transaction processing.

  • 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.

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

  • 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.

To use customized metadata for further analysis, reporting, or building custom rules to enhance fraud protection, you can define your customized metadata to be sent to the gateway. Currently, customized metadata of the Account object can be added to the following operations when configuring a Planet gateway instance:

  • Payment Method Planet Datatrans' Authorize a transaction API operation is used in authorizing funds. Metadata defined for Payment Method will be included in the request of this operation.

  • Payment Metadata defined for Payment will be included in the requests of the following transactions:

    • To process payment transactions, Planet Datatrans' Authorize a transaction and Initialize a transaction API operations are used. Metadata defined for Payment will be included in the request.

    • To process referenced refund transactions, Planet Datatrans' Refund a transaction API operation is used. The same metadata used for the payment will be included in the request.

To add a customized field, complete the following steps:

  1. If you want to pass in custom fields other than the standard fields of the Account object, create a legacy custom field on the Account object. Advanced custom fields are not supported. For example, create a legacy custom field called GlobalID with GlobalID__c as the API name.
  2. When creating or configuring a Planet gateway instance, click Add New Metadata in the Additional Metadata section.
  3. In the Metadata Key field, enter the metadata field name using the format userData<integer> , such as userData1 .
  4. Select a field from the list to indicate the metadata value. If you have defined a custom field in step 1, it will be loaded in the list, such as Account.GlobalID .

If you want to include the invoice number as metadata in the transaction to the gateway, submit a request at Zuora Global Support . If the invoice number is available in Zuora, the invoice number field will be mapped to the metadata.userData2 field and included in the following API requests to the gateway:

  • Payment transactions: Planet Datatrans' Authorize a transaction API

  • Referenced refund transactions: Planet Datatrans' Refund a transaction API

If metadata.userData2 is already mapped to another field, it will be overridden by the invoice number. If the Consolidating multiple invoices into one payment feature is enabled, the invoice number of the most recently created invoice will be used.

Last updated: February 9, 2026