Welcome to Zuora Product Documentation

Explore our rich library of product information

Enable and configure Real-Time Reconciliation for Checkout.com

Learn how to enable and configure Real-Time Reconciliation for Checkout.com in Zuora, including setting up a webhook endpoint and configuring merchant account details.

  • Ensure a Checkout.com payment gateway instance has been configured in Zuora. For more detailed information, see .
  • 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.

Use this procedure to enable and configure Real-Time Reconciliation (RTR) for Checkout.com in Zuora. The configuration includes two main steps:

  1. Configure the webhook endpoint in Checkout.com.
    Set up a webhook endpoint in Checkout.com to send reconciliation events to Zuora.
    1. Log in to your Checkout.com account.
    2. Go to the Webhooks page.
    3. Create a new webhook.

      Name:Enter a name of your choice.

      Endpoint URL:Enter the endpoint URL based on where your data center is located. For more detailed information, seeZuora Data Centers

      Signature Key:Generate a signature key. Copy the key. You will paste it into your payments UI configuration later.

      Note:

      Only the Signature Key must be configured for Real-Time Reconciliation. Do not configure or specify a Header Key.

  2. Enable Real-Time Reconciliation for Checkout.com in Zuora.
    To enable and configure Real-Time Reconciliation for Checkout.com, complete the following steps:
    1. Click your username in the upper right and navigate to Settings > Payments > Configure Real-Time Reconciliation .

      This page displays the following details for all the available Real-Time Reconciliation configuration mappings for active gateway authentication credentials:

      • Name:the name of your merchant account.
      • Gateway Type:the type of the gateway instance associated with the Real-Time Reconciliation service.
      • Gateway Identifier:your merchant account name.
      • 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 user who will perform the reconciliation actions.
    2. Select Checkout.com from the Gateway Type dropdown 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.
    4. In the Merchant Company Name field, enter your Checkout.com merchant company name.
      It must be identical to the value of the Merchant Company's Name field on your Checkout.com gateway instance configuration page in Zuora. For more detailed information, see .
    5. In the Secret Key field, enter the signature key that you generated in Configure the webhook endpoint in Checkout.com.
    6. In the User to reconcile events section, select one of the following options. Ensure the user has obtained the required permissions. Only users created through the Zuora UI are displayed in the list. Users created through OneID are not available.
      • 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.
    7. Click Submit.

For dispute events, by default, external refunds are automatically generated for dispute events. If you want to opt out of this default behavior and disable the generation of external refunds for dispute events, submit a request at Zuora Global Support .