Configure Real-Time Reconciliation
The Real-Time Reconciliation feature is supported by the following gateway integrations. Use the instructions in this article to configure Real-Time Reconciliation for different gateways.
- 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.
- To ensure that the Gateway Reconciliation job is able to create external refunds when required, activate the Payment Rejection reason code for Payment Refund on your tenant. For how to activate a reason code, see Creating and editing reason codes.
- The multi-entity feature is not enabled on your tenant. Because the Real-Time Reconciliation feature is not compatible with the multi-entity feature, Real-Time Reconciliation is not available if multi-entity is enabled.
Procedure
- Click your username in the upper right and navigate to Settings > Payments > Configure GoCardless 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.
- 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.
- Ensure that the merchant account ID has not been configured for any tenant for Real-Time Reconciliation enablement. If an account ID is configured for multiple tenants with Real-Time Reconciliation enabled, only one tenant can receive the Real-Time Reconciliation events.
- To ensure that the Gateway Reconciliation job is able to create external refunds when required, activate the Payment Rejection reason code for Payment Refund on your tenant. For how to activate a reason code, see Creating and editing reason codes.
Procedure
To enable Real-Time Reconciliation for Stripe v2, complete the following steps:
- Click your username in the upper right and navigate to Settings > Payments > Configure Stripe Real-Time Reconciliation. This page displays all available Real-Time Reconciliation configuration mappings for active gateway authentication tokens.
- Name: the name of the OAuth token for gateway authentication.
- Gateway Type: the type of the gateway instance associated with the OAuth token.
- Gateway Identifier: the ID of the Stripe account associated with the OAuth token.
- User: the Zuora username of the user who performs the reconciliation actions.
- Actions: the operations for managing the Real-Time Reconciliation configuration, including deleting a configuration mapping and updating the user who will perform the reconciliation actions.
- From the Gateway Merchant Account dropdown list, select the authentication token that you have created through the Gateway Authentication payment setting, and then click Add.
- In the User to reconcile events section of the Enable Real-Time Reconciliation page, select any of the following options to define the user who will be used by Zuora to perform the reconciliation actions:
- 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.
- Click Submit. The corresponding Real-Time Reconciliation configuration is added to this page.
After Real-Time Reconciliation is enabled, to change the user who will be used by Zuora to perform reconciliation actions, complete the following steps:
- Click your username in the upper right and navigate to Settings > Payments > Configure Stripe Real-Time Reconciliation.
- In the Action cell of the Real-Time Reconciliation configuration record, click Edit.
- On the Enable Real-Time Reconciliation page, select any of the following options to define the user who will be used by Zuora to perform the reconciliation actions:
- 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.
- Click Submit.