Welcome to Zuora Product Documentation

Explore our rich library of product information

Enable and configure Real-Time Reconciliation for Braintree v2.0

Learn how to enable and configure Real-Time Reconciliation for Braintree v2.0 in Zuora, including setting up a Braintree gateway instance, configuring webhooks, and managing reconciliation credentials.

Before you begin, ensure that the following requirements are met:

  • A Braintree v2.0 gateway instance is configured in Zuora.
  • The merchant ID is not configured for any other tenant or entity for Real-Time Reconciliation. Zuora does not support configuring the same merchant ID for multiple tenants or entities in the same environment.
  • In your Braintree merchant console, configure the webhook service. For instructions, see the Braintree webhook documentation.

    When you configure the service URL, use the following format:

    <Zuora_Data_Center_URL>/payment-reconciliation-webhook/braintree/v1/<merchantId>

    For example: https://rest.sandbox.na.zuora.com/payment-reconciliation-webhook/braintree/v1/abc12345def678y.

    To identify your data center, check the URL of your Zuora environment. For more information, see Zuora data centers.

To enable and configure Real-Time Reconciliation for Braintree v2.0, complete the following steps:

  1. Click your username in the upper right corner, and then navigate to Settings > Payments > Configure Real-Time Reconciliation.

    The Configure Real-Time Reconciliation page displays all available Real-Time Reconciliation configuration mappings for active gateway authentication credentials. The following table describes the information shown on this page:

    FieldDescription
    NameThe merchant ID of your Braintree merchant account.
    Gateway TypeThe type of gateway instance associated with the Real-Time Reconciliation service.
    Gateway IdentifierThe merchant ID of your Braintree merchant account.
    UserThe Zuora username of the user who performs the reconciliation actions.
    ActionsThe operations for managing the Real-Time Reconciliation configuration:
    • Delete: Deletes a configuration mapping.
    • Edit: Updates the Public Key, Private Key, and Use Gateway Test Environment settings, and the user who performs the reconciliation actions.
  2. From the Gateway Type drop-down list, select Braintree, and then click Add.
  3. In the Configuration to reconcile events section on the Enable Real-Time Reconciliation page, enter the credentials required to validate and process webhooks from Braintree.

    Provide the following credentials:

    • In the Merchant ID field, enter your Braintree merchant ID.
    • In the Public Key field, enter the public key from your Braintree account.
    • In the Private Key field, enter the private key from your Braintree account.
    • If the credentials are for the sandbox environment, select Use Gateway Test Environment.
  4. In the User to reconcile events section, specify the user that Zuora uses to perform the reconciliation actions.

    Select one of the following options:

    • Current User: The user who is signed in to Zuora and is performing this Real-Time Reconciliation enablement.
    • Select a User: Select a user from the list who has the required permissions to perform reconciliation actions.
    Note: Ensure that the selected user has the required permissions. Only users created through the Zuora UI appear in the list. Users created through One ID are not available.
  5. Click Submit.