Skip to main content

Payment Gateway Authentication


Payment Gateway Authentication

You can use the Gateway Authentication setting to create and manage the OAuth tokens for the following types of gateways that support OAuth 2.0 authentication:

  • GoCardless 
  • Stripe v1
  • Stripe v2

All active tokens displayed on the Gateway Authentication page are available for configuration on the gateway configuration page for new and existing gateway instances that support OAuth 2.0 authentication.

With the OAuth token specified, the gateway instances in Zuora will include the token in each request sent to the gateway to perform the OAuth 2.0 authentication.

To update a gateway instance that is in use with an OAuth token, you must ensure that the token generated and associated with this instance authenticates with the same merchant account as before.

Create an OAuth access token

Take the following steps to create a new OAuth token:

  1. Navigate to the Payments Settings page and click Gateway Authentication.
  2. Select the gateway type from the list and click create authentication. The New Authentication page opens.

  3. Enter a name for the token that can help you identify the token.

  4. Verify that the correct type of gateway is selected.

  5. If you want to use the gateway test environment, select Use Gateway Test Environment.

  6. Click save. You are then directed to the gateway app login page.

  7. Take the following steps to complete the token creation:

    • GoCardless:

      1. Enter your email address and password that are used to log into your GoCardless merchant account.

      2. Ensure that the I agree to the Connected Merchant Agreement checkbox is selected, and click Connect account. You are then redirected back to your Zuora tenant.

    • Stripe

      1. Select the account to be connected.

      2. Click Connect. You are then redirected back to your Zuora tenant.

On the Stripe login page, if you are in the test mode, a Skip this form button is available at the top. If you click Skip this form, a test access token is created for accessing and testing functions, but it is not linked to your account. With this test access token, you are not able to view any payment transaction logs because your Stripe account is not connected to your Zuora account yet. You cannot make the refund with this test token for the payment that was created before you create this access token.

You can find that the created token with the specified name and active status is displayed in the token list.

Delete an OAuth access token

You can delete the OAuth access token in error, draft, or pending status. To delete an OAuth access token, navigate to the Payments Settings page, click Gateway Authentication, and then click delete next to the token that you want to delete.