Skip to main content

Real-Time Reconciliation

Zuora

Real-Time Reconciliation

Zuora's Gateway Reconciliation feature (also known as batch Gateway Reconciliation) allows Zuora to submit a batch job on a daily basis to retrieve gateway reconciliation reports. You can then view and download these reports that will aid in the transaction reconciliation efforts between Zuora and the gateway.

In addition to the batch Gateway Reconciliation feature, Zuora also provides Real-Time Reconciliation by integrating with the Webhook service provided by the applicable gateways. It gives you a more time-efficient option for reconciling transactions. With Real-Time Reconciliation enabled, 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.

Currently, the Real-Time Reconciliation feature is supported by the following gateway integrations. Real-Time Reconciliation supports all payment methods of these gateway integrations:

  • GoCardless
  • Stripe v2

Configure Real-Time Reconciliation for GoCardless

Prerequisites

  • A GoCardless gateway instance has been configured in Zuora.
  • You have created at least one authentication mechanism set up through the Gateway Authentication payment setting.

Procedure

  1. Navigate to Payments Settings > Configure Real-Time Reconciliation. This page displays all available webhooks. Each time you create an authentication mechanism such as OAuth through the Gateway Authentication payment setting, a corresponding webhook is automatically added to this page.
  2. Find the webhook you want to use, and click Activate to activate this webhook.

After the webhook is activated, updates to different gateway events will be reflected in Zuora in real-time.

The GoCardless Webhook service might delay sending notifications to Zuora for 2 or 3 days. The corresponding records in Zuora will not be updated until the notifications from GoCardless are received. If you have any questions about this delay, please contact GoCardless.

Configure Real-Time Reconciliation for Stripe v2

Prerequisites

  • A Stripe v2 gateway instance has been configured in Zuora. See Stripe payment gateway for instructions about how to create an instance of the gateway.
  • At least one OAuth token for Stripe v2 has been created and activated through the Gateway Authentication payment setting for the intended gateway instance.
  • Zuora user used for reconciling transactions is the same user that created the OAuth token. Ensure that this user has the permission of “unapplying payments” to reconcile the payment reject and chargeback events.

Enable Real-Time Reconciliation for Stripe v2

Submit a request to Zuora Global Support and include the following information in your request:

  • Stripe ID of the Stripe Merchant account that will be used for transacting and is associated with the intended gateway instance
  • The name of the OAuth token that is associated with the intended gateway instance
  • Tenant ID

After the webhook is activated, updates to different gateway events will be reflected in Zuora in real-time.

Supported events with Real-Time Reconciliation enabled

For information about the supported events and the corresponding actions from Zuora for different gateway integrations, see the following articles:

The events stored in Zuora can be queryable from the PaymentGatewayReconciliationEventLog object in Data Query.

Limitations

  • For Stripe v2, the Real-Time Reconciliation feature is compatible with the multi-entity feature, only if each entity has its own unique merchant account ID to authenticate through the OAuth 2.0 authentication. If an account ID is configured for multiple tenants with Real-Time Reconciliation enabled, only one tenant can receive the Real-Time Reconciliation events.
  • For GoCardless, the Real-Time Reconciliation feature is not compatible with the multi-entity feature. For tenants with the multi-entity feature enabled, you can leverage Gateway Reconciliation batch jobs for GoCardless for transaction reconciliation. For more information about GR batch jobs for GoCardless, see the following articles: