Mercury

Overview

Connect your users to Mercury for business banking data, account balances, transactions, and financial management.

Property	Value
Provider ID	mercury
Category	Finance
PKCE	Supported
Token refresh	Automatic
Redirect URI	Shown in Developer Portal

Step 1: Create a Mercury OAuth App

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.

Wait for Mercury to provision credentials

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

Register the redirect URI

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

Enter credentials in Alter Vault

Use the Client ID and Client Secret from Mercury in the Developer Portal (see Step 2 below).

Warning

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

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Mercury provider

Go to OAuth Providers > Add Provider > Mercury.

Enter credentials

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

Select scopes

Choose the scopes the application needs.

Save

Click Save. The provider is now active.

Available Scopes

Scope	Description
read	Read access to Mercury account and transaction data
offline_access	Maintain continuous access with refresh tokens

Notes

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

Policy-cataloged operations

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation ID	Families	Method	Provider path
transactions/send-money	payment	POST	/api/v1/account/{accountId}/transactions
transactions/request-send-money	payment	POST	/api/v1/account/{accountId}/request-send-money
transfers/create	payment	POST	/api/v1/transfer
accounts/list	read	GET	/api/v1/accounts
accounts/cards	read	GET	/api/v1/account/{accountId}/cards
accounts/statements	read	GET	/api/v1/account/{accountId}/statements
cards/create	write	POST	/api/v1/cards
cards/get	read	GET	/api/v1/cards/{cardId}
cards/list	read	GET	/api/v1/cards
cards/update	write	POST	/api/v1/cards/{cardId}
cards/freeze	write	POST	/api/v1/cards/{cardId}/freeze
cards/unfreeze	write	POST	/api/v1/cards/{cardId}/unfreeze
categories/create	write	POST	/api/v1/categories
categories/list	read	GET	/api/v1/categories
credit/list	read	GET	/api/v1/credit
organization/get	read	GET	/api/v1/organization
recipients/create	write	POST	/api/v1/recipients
recipients/get	read	GET	/api/v1/recipient/{recipientId}
recipients/list	read	GET	/api/v1/recipients
recipients/update	write	POST	/api/v1/recipient/{recipientId}
recipients/delete	delete	DELETE	/api/v1/recipient/{recipientId}
transactions/get	read	GET	/api/v1/account/{accountId}/transaction/{transactionId}
transactions/list	read	GET	/api/v1/transactions
transactions/list-for-account	read	GET	/api/v1/account/{accountId}/transactions
transactions/update	write	PATCH	/api/v1/transaction/{transactionId}
transactions/upload-attachment	write	POST	/api/v1/transaction/{transactionId}/attachments
treasury/list	read	GET	/api/v1/treasury
treasury/transactions	read	GET	/api/v1/treasury/{treasuryId}/transactions
users/list	read	GET	/api/v1/users
webhooks/create	admin	POST	/api/v1/webhooks
webhooks/list	read	GET	/api/v1/webhooks