Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.alterauth.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Connect your users to Mercury for business banking data, account balances, transactions, and financial management.
PropertyValue
Provider IDmercury
CategoryFinance & HR
PKCESupported
Token refreshAutomatic
Redirect URIShown in Developer Portal

​
Step 1: Create a Mercury OAuth App

1

Review Mercury's OAuth integration guide

Open Mercury’s OAuth2 integration guide and submit an integration request. Mercury does not offer a self-serve developer console for OAuth.
2

Wait for Mercury to provision credentials

After approval, Mercury provides a Client ID and Client Secret.
3

Register the redirect URI

Provide the Alter callback URL from the Developer Portal as the registered Redirect URI.
4

Enter credentials in Alter Vault

Use the Client ID and Client Secret from Mercury in the Developer Portal (see Step 2 below).
Never share your Client Secret publicly. Store it securely and only enter it in the Alter Vault Developer Portal.

​
Step 2: Add to Alter Vault

1

Open the Developer Portal

Go to portal.alterauth.com and navigate to your app.
2

Add Mercury provider

Go to OAuth Providers > Add Provider > Mercury.
3

Enter credentials

  • Client ID: Paste your Mercury Client ID
  • Client Secret: Paste your Mercury Client Secret
4

Select scopes

Choose the scopes your app needs.
5

Save

Click Save. The provider is now active.

​
Available Scopes

ScopeDescription
readRead-only access to account and transaction data
offline_accessMaintain continuous access with refresh tokens

​
Notes

  • Request only the scopes your application needs. For read-only financial dashboards, read is sufficient.
  • See the Mercury OAuth documentation for more details.