Zuora Setup

Learn how to connect Zuora and BlueSnap to build a unified solution for subscriptions and payment processing

BlueSnap’s integration with Zuora enables you to leverage Zuora’s subscription management platform while taking advantage of BlueSnap’s robust global payment gateway.

Supported features

  • Cards
  • ACH
  • SEPA
  • Account Updater*
  • Level 2/3 Data
  • Coming Soon: LatAm and ApplePay

*For the BlueSnap-Zuora integration, the BlueSnap Account Updater supports VISA and Mastercard. Zuora uses their own proprietary account updater for Amex.

Follow this simple setup process to get up and running quickly:

1. Creating your BlueSnap API credentials
2. Setting up the BlueSnap gateway in Zuora
3. Testing the integration

Then, check out some Best practices & tips to get the most out of your integration.

1. Creating your BlueSnap API credentials

In this step, you will create BlueSnap API credentials. You will need these credentials later when you configure the BlueSnap gateway in Zuora.

  1. In the BlueSnap Merchant Console, log in to your sandbox or production account and then go to Settings > API Settings.

  2. Define your API password.

  3. Enter these Zuora IPs, depending on whether you are in the sandbox or production environment:

    • Zuora sandbox IP:
    • Zuora production IP:
  4. Click Request API credentials.
    The credentials are generated and your new API username is displayed.

2. Setting up the BlueSnap gateway in Zuora

In your Zuora tenant (the tenant is your Zuora account), you will need to configure the BlueSnap gateway and set it as the default. If you have any questions, see Zuora's documentation.

  1. Log in to the Zuora test or production environment:
  1. In the top menu, navigate to Settings > Z-Payments Settings > Setup Payment Gateway.

  2. If you have not yet created the BlueSnap gateway, follow these steps (otherwise, skip to step 4):
    a. Select the BlueSnap gateway type and then click create gateway.

    b. In the Basic Information section, define the gateway name and select the Use Gateway Test Environment option if you would like to use the Zuora test environment with the BlueSnap sandbox.

    c. In the Credentials section, enter the API username and password you generated for BlueSnap. Make sure you enter the correct credentials either for the sandbox or production.

    d. In the Rules section, select the card types you want to support and configure any other relevant settings.

    e. Click save gateway information. The BlueSnap gateway is created and appears in the list.

  3. In the list of payment gateways, make sure the BlueSnap gateway is active and set as the default. Click the options in the Actions column to change this, if needed.

3. Testing the integration

Once you complete setup, you can test the integration by initiating a transaction from Zuora and then verifying that the transaction appears in BlueSnap.

  1. In Zuora, initiate a transaction by following their How to Get Started instructions:

  2. In Zuora, go to Billing Operations > Invoice. On the relevant invoice, locate the Transaction Number. You will use this number to locate the transaction in your BlueSnap Merchant Console next.

  1. Optionally, to view payment details and to verify that the transaction was successfully processed on the BlueSnap side, click the Transaction Number. On the payment page, under the Basic Information section, you'll see a Reference ID. If you do not find a Reference ID or an error message appears, this indicates that the transaction was not processed properly on the BlueSnap side. For details about errors and possible solutions, please see BlueSnap’s error reference.

  2. In your BlueSnap Merchant Console, log in to your sandbox or production account and then go to Transactions > Find a Transaction. From the ID Type dropdown, select Merchant Transaction ID and then enter the Transaction Number that you found in Zuora. Click Locate to look it up.

If the transaction is found, the integration is set up and ready to go! If the transaction is not found, please reach out to BlueSnap Support at merchants@bluesnap.com.

Best practices & tips

Migrating subscription data to Zuora

If you would like Zuora to maintain your subscriptions in their system, you can migrate subscriptions from BlueSnap to Zuora using Zuora’s out-of-the-box tools. For guidelines, please see Zuora's documentation.


You have access to both BlueSnap's and Zuora's reporting capabilities, enabling you to gain a comprehensive understanding of your eCommerce data . For example, in BlueSnap, you can view detailed payout reports, and in Zuora, you can customize a Detail report according to a specific Zuora Data Source.

To learn more about BlueSnap's reporting capabilities, see BlueSnap Reporting. To learn more about Zuora's reporting capabilities, see Zuora's documentation.

Payout reconciliation

To reconcile BlueSnap payouts with Zuora transactions, check out BlueSnap's Payout Detail report. Use the Merchant Transaction ID parameter (whose value is the Transaction Number in Zuora) to cross-reference.

Zuora Setup

Learn how to connect Zuora and BlueSnap to build a unified solution for subscriptions and payment processing

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.