Skip to main content

Set up a payment hub

Zuora

Set up a payment hub

  1. Last updated
  2. Save as PDF

Introduction

You need to set up and configure a web server hosted outside of Zuora as the payment hub to process requests and responses between the custom payment gateway configured in Zuora and the external payment gateway. If the payment gateway is building an integration on your behalf, you can skip this section.

When the payment hub receives a request from the custom payment gateway in Zuora, it validates the credentials and then sends the request to an external payment gateway. When the payment hub receives a response from the external payment gateway, it sends the response back to the custom payment gateway in Zuora’s format. 

It is recommended to configure your web server with the following factors considered:

  • High concurrency. The payment hub might need to be configured with the message queue to process the highly concurrent payment requests.
  • Deduplication. Payment retry might be triggered when a payment fails. The payment hub might need to be configured with the deduplication capability to avoid duplicated payment collection.
  • When setting up the custom payment gateway instance in Zuora in the next step, the endpoint and access credentials of the payment hub will be required. Note the following restrictions:
    • When specifying the endpoint of the payment hub, note the following restrictions due to security reasons:
      • Only the https scheme is supported.
      • The host address in the endpoint must be a registered hostname, but not an IP address.
      • Only the default 443 https port is supported. You can skip specifying the port and the 443 port will be used.
    • For the credentials to access the payment hub, only basic authentication is supported for the time being.

For more information about the payment hub requests and responses, see Requests and responses processed by the payment hub.