Skip to main content

Real-Time Reconciliation

Zuora

Real-Time Reconciliation

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, this feature is only supported by the GoCardless gateway.

Configure Real-Time Reconciliation

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.

Real-time Reconciliation Event Mapping between GoCardless and Zuora

The following table lists Zuora's actions on GoCardless events when the Real-time Gateway Reconciliation feature is enabled. 

GoCardless event type GoCardless event Zuora action
Mandate created Zuora ignores this event because the payment method is created.
customer_approval_granted N/A
customer_approval_skipped N/A
active N/A
submitted N/A
reinstated Zuora activates the payment method.
cancelled Zuora closes the payment method.
failed Zuora closes the payment method.
transferred N/A
expired Zuora closes the payment method.
resubmission_requested Zuora activates the payment method.
replaced N/A
Payment customer_approval_denied
  • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
  • Zuora creates an External Refund with the Reason Code set to "Payment Rejection".
confirmed Zuora updates the Gateway State to "Settled" and the Settled On date field of the Payment event.
cancelled
  • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
  • Zuora creates an External Refund with the Reason Code set to "Payment Rejection".
failed
  • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
  • Zuora creates an External Refund with the Reason Code set to "Payment Rejection".
charged_back
  • Zuora updates the Gateway State to "Settled" on the Payment transaction.
  • Zuora creates an External Refund.
chargeback_cancelled N/A
late_failure_settled
  • Zuora updates the Gateway State to "Settled" on the Payment transaction.
  • Zuora creates an External Refund.
created N/A
customer_approval_granted N/A
submitted N/A
paid_out N/A
chargeback_settled N/A
surcharge_fee_credited N/A
surcharge_fee_debited N/A
Refund paid N/A
refund_settled N/A
created N/A
failed N/A
refund_returned N/A
Payout paid Update payment
fx_rate_confirmed N/A
tax_exchange_rates_confirmed N/A

Limitations

  • The Real-Time Reconciliation feature is not supported in the Zuora Central Sandbox environment.
  • The Real-Time Reconciliation feature is not compatible with Multi-entity.