Skip to main content

Real-Time Reconciliation on Planet

Zuora

Real-Time Reconciliation on Planet

  1. Last updated
  2. Save as PDF

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

With Real-Time Reconciliation enabled on your tenant, the payment gateway can submit notifications to Zuora for various event types on gateway objects, and the corresponding records can be automatically updated in real-time.

Real-Time Reconciliation events

The following table lists the supported Planet Datatrans events for Real-time Reconciliation and Zuora's actions:

Planet Datatrans event type Zuora Action
  • Authorized
  • Settled
 Zuora updates the Gateway State to "Settled" on the payment transaction.
  • Failed
  • Canceled 
  • Zuora updates the Gateway State to "FailedToSettle" on the payment transaction.
  • Zuora creates an external refund with the reason code set to "Payment Rejection" if the code is active in the Reason Codes list. Otherwise, Zuora creates an external refund with the reason code set to the default reason code in the list.
If the Support refunding payments from the credit balance with Gateway Reconciliation setting is enabled, a credit balance refund will be created. See Refund payments with credit balance in gateway reconciliation for more information.

Configure Real-Time Reconciliation for Planet

Prerequisites

  • Retrieve the HMAC key in the Datatrans dashboard:
    1. Open the Security tab, and then navigate to Security Signature.
    2. If the HMAC key already exists, find it in the third section. Otherwise, generate a new HMAC key.
    3. Copy the HMAC key, which will be used in the configuration of Real-Time Reconciliation in Zuora.
  • Ensure that the merchant ID has not been configured for any tenant or entity for Real-Time Reconciliation enablement. Configuring one merchant ID for multiple entities or tenants in the same environment for Real-Time Reconciliation is not supported.
  • The user configured to perform Real-Time Reconciliation actions must have the following permissions, if the Invoice Settlement feature is enabled on your tenant. Contact your tenant administrator to update the user role or corresponding permissions.

Procedure

To enable and configure Real-Time Reconciliation for Planet in Zuora, complete the following steps:

  1. Click your username in the upper right and navigate to Settings > Payments > Configure Real-Time Reconciliation. This page displays all available Real-Time Reconciliation configuration mappings for active gateway authentication credentials.
    • Name: the Planet merchant ID.
    • Gateway Type: the type of the gateway instance associated with the Real-Time Reconciliation service.
    • Gateway Identifier: the Planet merchant ID.
    • User: the Zuora username of the user who performs the reconciliation actions.
    • Actions: the operations for managing the Real-Time Reconciliation configuration:
      • Delete: Delete a configuration mapping.
      • Edit: Update the HMAC key or the user who will perform the reconciliation actions.
  2. Select Planet from the Gateway Type list, and then click Add.
  3. On the Enable Real-Time Reconciliation page, add the merchant account and user that will be used by Zuora to perform the reconciliation actions.
    1. In the Gateway Merchant Account field, enter your Planet merchant ID.
    2. In the HMAC Key field, enter the HMAC key.
    3. In the User to reconcile events section, select any of the following options. Ensure the user has obtained the required permissions. Note that only users created through the Zuora UI are loaded in the list. Users created through One ID are not available in the list.
      • Current User: the user who is logging in to Zuora and performing this Real-Time Reconciliation enablement.
      • Select a User: Select a user from the list who has obtained the required permissions to perform reconciliation actions.
  4. Click Submit.