Mercury
Connect to Mercury to access business banking accounts, transactions, payments, cards, invoices, and related financial data.
Authentication
| Method | Kind | Status | Details |
|---|---|---|---|
| API Token | api_key | available | — |
| OAuth 2.0 (approved integrations) | oauth2 | available | — |
Call a tool
import { createClient } from "@open-connector/sdk";const oc = createClient({ baseUrl: "https://api.openconnector.dev", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({ slug: "MERCURY_APPROVE_REIMBURSEMENT", connectedAccountId: "conn_...", arguments: { /* match this tool's input schema */ },});import Composio from "@composio/client";const composio = new Composio({ baseURL: "https://api.openconnector.dev/composio", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("MERCURY_APPROVE_REIMBURSEMENT", { connected_account_id: "conn_...", arguments: { /* match this tool's input schema */ },});oc tools execute MERCURY_APPROVE_REIMBURSEMENT --data '{ }'Tool catalog
Available tools
89 callable operations
Approve a reimbursementMERCURY_APPROVE_REIMBURSEMENTApprove a submitted reimbursement. Payout is a separate, scheduled sweep; poll the payment status.Connection
Approve a submitted reimbursement. Payout is a separate, scheduled sweep; poll the payment status.
Authentication
Connected account requiredTags
Cancel a cardMERCURY_CANCEL_CARDPermanently cancel a card. This action cannot be undone.Connection
Permanently cancel a card. This action cannot be undone.
Authentication
Connected account requiredTags
Cancel an invoiceMERCURY_CANCEL_INVOICECancel an invoice. This action cannot be undone.Connection
Cancel an invoice. This action cannot be undone.
Authentication
Connected account requiredTags
Cancel a reimbursementMERCURY_CANCEL_REIMBURSEMENTCancel a reimbursement that is still in review.Connection
Cancel a reimbursement that is still in review.
Authentication
Connected account requiredTags
Create a cardMERCURY_CREATE_CARDIssue a new virtual card.Connection
Issue a new virtual card.
Authentication
Connected account requiredTags
Create a new categoryMERCURY_CREATE_CATEGORYCreate a new custom expense category for the organization.Connection
Create a new custom expense category for the organization.
Authentication
Connected account requiredTags
Create a customerMERCURY_CREATE_CUSTOMERCreate a new customer for the organizationConnection
Create a new customer for the organization
Authentication
Connected account requiredTags
Create an internal transferMERCURY_CREATE_INTERNAL_TRANSFERTransfer funds between two accounts within the same organization. Supports transfers between depository accounts (checking/savings), from a depository account to a treasury/investment account, and from a treasury/investment account to a depository account. Creates paired debit and credit transactions.Connection
Transfer funds between two accounts within the same organization. Supports transfers between depository accounts (checking/savings), from a depository account to a treasury/investment account, and from a treasury/investment account to a depository account. Creates paired debit and credit transactions.
Authentication
Connected account requiredTags
Create an invoiceMERCURY_CREATE_INVOICECreate a new invoice for the organizationConnection
Create a new invoice for the organization
Authentication
Connected account requiredTags
Add a new recipientMERCURY_CREATE_RECIPIENTCreate a new recipient for making paymentsConnection
Create a new recipient for making payments
Authentication
Connected account requiredTags
Create a recipient inviteMERCURY_CREATE_RECIPIENT_INVITECreate an invite for a recipient to submit their payment details. Supply a recipientId to invite an existing recipient; omit it to invite someone new, in which case the recipient is created when the invitee completes onboarding.Connection
Create an invite for a recipient to submit their payment details. Supply a recipientId to invite an existing recipient; omit it to invite someone new, in which case the recipient is created when the invitee completes onboarding.
Authentication
Connected account requiredTags
Create a reimbursementMERCURY_CREATE_REIMBURSEMENTSubmit a new reimbursement on behalf of the organization. Returns the new reimbursement id.Connection
Submit a new reimbursement on behalf of the organization. Returns the new reimbursement id.
Authentication
Connected account requiredTags
Send money to a recipientMERCURY_CREATE_TRANSACTIONSend money from an account to a recipient. Creates a transaction that will be processed immediately or may require approval.Connection
Send money from an account to a recipient. Creates a transaction that will be processed immediately or may require approval.
Authentication
Connected account requiredTags
Create a new webhook endpointMERCURY_CREATE_WEBHOOKRegister a new webhook endpoint to receive event notificationsConnection
Register a new webhook endpoint to receive event notifications
Authentication
Connected account requiredTags
Delete a Chart of Accounts TemplateMERCURY_DELETE_BOOKS_AGENT_COA_TEMPLATEDelete a specific Chart of Accounts template.Connection
Delete a specific Chart of Accounts template.
Authentication
Connected account requiredTags
Delete a Ledger TemplateMERCURY_DELETE_BOOKS_AGENT_LEDGER_TEMPLATEDelete an existing ledger within an agent-owned Chart of Accounts template.Connection
Delete an existing ledger within an agent-owned Chart of Accounts template.
Authentication
Connected account requiredTags
Bulk delete journal entriesMERCURY_DELETE_BOOKS_JOURNAL_ENTRIESBulk delete journal entriesConnection
Bulk delete journal entries
Authentication
Connected account requiredTags
Delete a categoryMERCURY_DELETE_CATEGORYDelete a custom expense category for the organization.Connection
Delete a custom expense category for the organization.
Authentication
Connected account requiredTags
Delete a customerMERCURY_DELETE_CUSTOMERDelete a customer. This action cannot be undone.Connection
Delete a customer. This action cannot be undone.
Authentication
Connected account requiredTags
Delete a recipientMERCURY_DELETE_RECIPIENTDelete a specific recipient by ID. Fails if the recipient is blocked by scheduled payments, pending approvals, or active ACH authorizations.Connection
Delete a specific recipient by ID. Fails if the recipient is blocked by scheduled payments, pending approvals, or active ACH authorizations.
Authentication
Connected account requiredTags
Delete a recipient inviteMERCURY_DELETE_RECIPIENT_INVITEDelete an active recipient invite.Connection
Delete an active recipient invite.
Authentication
Connected account requiredTags
Delete a webhook endpointMERCURY_DELETE_WEBHOOKDelete a webhook endpointConnection
Delete a webhook endpoint
Authentication
Connected account requiredTags
Deny a reimbursementMERCURY_DENY_REIMBURSEMENTDeny a submitted reimbursement. The reason is recorded as a reviewer comment.Connection
Deny a submitted reimbursement. The reason is recorded as a reviewer comment.
Authentication
Connected account requiredTags
Edit a categoryMERCURY_EDIT_CATEGORYUpdate an existing custom expense category for the organization.Connection
Update an existing custom expense category for the organization.
Authentication
Connected account requiredTags
Freeze a cardMERCURY_FREEZE_CARDTemporarily freeze a card. The card must be active.Connection
Temporarily freeze a card. The card must be active.
Authentication
Connected account requiredTags
Get account by IDMERCURY_GET_ACCOUNTGet account by IDConnection
Get account by ID
Authentication
Connected account requiredTags
Get cards for accountMERCURY_GET_ACCOUNT_CARDSRetrieve all debit and credit cards associated with a specific account.Connection
Retrieve all debit and credit cards associated with a specific account.
Authentication
Connected account requiredTags
Get account statementsMERCURY_GET_ACCOUNT_STATEMENTSRetrieve a paginated list of monthly statements for a specific account. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters, as well as date range filtering with start and end parameters.Connection
Retrieve a paginated list of monthly statements for a specific account. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters, as well as date range filtering with start and end parameters.
Authentication
Connected account requiredTags
Get all accountsMERCURY_GET_ACCOUNTSRetrieve a paginated list of accounts. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.Connection
Retrieve a paginated list of accounts. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.
Authentication
Connected account requiredTags
Get an attachmentMERCURY_GET_ATTACHMENTRetrieve attachment details including download URLConnection
Retrieve attachment details including download URL
Authentication
Connected account requiredTags
Retrieve a Chart of Accounts TemplateMERCURY_GET_BOOKS_AGENT_COA_TEMPLATERetrieve details of a specific Chart of Accounts template.Connection
Retrieve details of a specific Chart of Accounts template.
Authentication
Connected account requiredTags
List all Chart of Accounts TemplatesMERCURY_GET_BOOKS_AGENT_COA_TEMPLATESRetrieve a paginated list of all default and agent-owned Chart of Accounts templates. These templates can be used when creating new Books instances for clients.Connection
Retrieve a paginated list of all default and agent-owned Chart of Accounts templates. These templates can be used when creating new Books instances for clients.
Authentication
Connected account requiredTags
List all journal entriesMERCURY_GET_BOOKS_JOURNAL_ENTRIESList all journal entriesConnection
List all journal entries
Authentication
Connected account requiredTags
Retrieve a Journal EntryMERCURY_GET_BOOKS_JOURNAL_ENTRYRetrieve a Journal EntryConnection
Retrieve a Journal Entry
Authentication
Connected account requiredTags
Get a cardMERCURY_GET_CARDRetrieve details of a specific card by its ID.Connection
Retrieve details of a specific card by its ID.
Authentication
Connected account requiredTags
Get a customerMERCURY_GET_CUSTOMERRetrieve details of a specific customer by their IDConnection
Retrieve details of a specific customer by their ID
Authentication
Connected account requiredTags
Get event by IDMERCURY_GET_EVENTGet event by IDConnection
Get event by ID
Authentication
Connected account requiredTags
Get all eventsMERCURY_GET_EVENTSGet all eventsConnection
Get all events
Authentication
Connected account requiredTags
Get an invoiceMERCURY_GET_INVOICERetrieve details of an invoice by its IDConnection
Retrieve details of an invoice by its ID
Authentication
Connected account requiredTags
Download invoice PDFMERCURY_GET_INVOICE_PDFDownloads a PDF file for the specified invoice. The response includes a Content-Disposition header set to 'attachment' with the filename.Connection
Downloads a PDF file for the specified invoice. The response includes a Content-Disposition header set to 'attachment' with the filename.
Authentication
Connected account requiredTags
Get organization informationMERCURY_GET_ORGANIZATIONRetrieve information about your organization including EIN, legal business name, and DBAs.Connection
Retrieve information about your organization including EIN, legal business name, and DBAs.
Authentication
Connected account requiredTags
Get recipient by IDMERCURY_GET_RECIPIENTRetrieve details of a specific recipient by IDConnection
Retrieve details of a specific recipient by ID
Authentication
Connected account requiredTags
Get recipient invite by IDMERCURY_GET_RECIPIENT_INVITERetrieve details of a specific recipient invite by ID.Connection
Retrieve details of a specific recipient invite by ID.
Authentication
Connected account requiredTags
Get all recipientsMERCURY_GET_RECIPIENTSRetrieve a paginated list of all recipients. Use cursor parameters (start_after, end_before) for pagination.Connection
Retrieve a paginated list of all recipients. Use cursor parameters (start_after, end_before) for pagination.
Authentication
Connected account requiredTags
Get a reimbursementMERCURY_GET_REIMBURSEMENTRetrieve details of a specific reimbursement by its id, including its review and payment status.Connection
Retrieve details of a specific reimbursement by its id, including its review and payment status.
Authentication
Connected account requiredTags
Get SAFE by IDMERCURY_GET_SAFE_REQUESTRetrieve a specific SAFE request by its ID.Connection
Retrieve a specific SAFE request by its ID.
Authentication
Connected account requiredTags
Download SAFE documentMERCURY_GET_SAFE_REQUEST_DOCUMENTDownload the PDF document for a specific SAFE request. Returns binary PDF data with a Content-Disposition header.Connection
Download the PDF document for a specific SAFE request. Returns binary PDF data with a Content-Disposition header.
Authentication
Connected account requiredTags
Get all SAFEsMERCURY_GET_SAFE_REQUESTSRetrieve all SAFE (Simple Agreement for Future Equity) requests for your organization.Connection
Retrieve all SAFE (Simple Agreement for Future Equity) requests for your organization.
Authentication
Connected account requiredTags
Get send money approval request by IDMERCURY_GET_SEND_MONEY_APPROVAL_REQUESTGet send money approval request by IDConnection
Get send money approval request by ID
Authentication
Connected account requiredTags
Download account statement PDFMERCURY_GET_STATEMENT_PDFDownloads a PDF file for the specified account statement. The response includes a Content-Disposition header for proper file download handling. Returns binary PDF data.Connection
Downloads a PDF file for the specified account statement. The response includes a Content-Disposition header for proper file download handling. Returns binary PDF data.
Authentication
Connected account requiredTags
Get transaction by IDMERCURY_GET_TRANSACTIONGet transaction by IDConnection
Get transaction by ID
Authentication
Connected account requiredTags
Get a transaction by IDMERCURY_GET_TRANSACTION_BY_IDRetrieve a single transaction by its ID. Returns full transaction details including attachments, check images, and related metadata.Connection
Retrieve a single transaction by its ID. Returns full transaction details including attachments, check images, and related metadata.
Authentication
Connected account requiredTags
Get all treasury accountsMERCURY_GET_TREASURYRetrieve a paginated list of all treasury accounts associated with the authenticated organization. Use cursor parameters (start_after, end_before) for pagination.Connection
Retrieve a paginated list of all treasury accounts associated with the authenticated organization. Use cursor parameters (start_after, end_before) for pagination.
Authentication
Connected account requiredTags
Get treasury account statementsMERCURY_GET_TREASURY_STATEMENTSRetrieve a paginated list of statements for a specific treasury account. Supports cursor-based pagination and filtering by document type.Connection
Retrieve a paginated list of statements for a specific treasury account. Supports cursor-based pagination and filtering by document type.
Authentication
Connected account requiredTags
Get treasury transactionsMERCURY_GET_TREASURY_TRANSACTIONSRetrieve paginated treasury transactions for a specific treasury account.Connection
Retrieve paginated treasury transactions for a specific treasury account.
Authentication
Connected account requiredTags
Get user by IDMERCURY_GET_USERGet user by IDConnection
Get user by ID
Authentication
Connected account requiredTags
Get all usersMERCURY_GET_USERSGet all usersConnection
Get all users
Authentication
Connected account requiredTags
Get webhook endpoint by IDMERCURY_GET_WEBHOOKRetrieve details of a specific webhook endpoint by IDConnection
Retrieve details of a specific webhook endpoint by ID
Authentication
Connected account requiredTags
Get webhook endpointsMERCURY_GET_WEBHOOKSRetrieve a paginated list of all webhook endpoints for your organization. Supports filtering by status.Connection
Retrieve a paginated list of all webhook endpoints for your organization. Supports filtering by status.
Authentication
Connected account requiredTags
List account transactionsMERCURY_LIST_ACCOUNT_TRANSACTIONSRetrieve a paginated list of transactions for a specific account. Supports filtering by date range, status, and search terms.Connection
Retrieve a paginated list of transactions for a specific account. Supports filtering by date range, status, and search terms.
Authentication
Connected account requiredTags
List cardsMERCURY_LIST_CARDSRetrieve a paginated list of cards.Connection
Retrieve a paginated list of cards.
Authentication
Connected account requiredTags
List all categoriesMERCURY_LIST_CATEGORIESRetrieve a paginated list of all available custom expense categories for the organization. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.Connection
Retrieve a paginated list of all available custom expense categories for the organization. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.
Authentication
Connected account requiredTags
List all credit accountsMERCURY_LIST_CREDITRetrieve a list of all credit accounts for the organization.Connection
Retrieve a list of all credit accounts for the organization.
Authentication
Connected account requiredTags
List all customersMERCURY_LIST_CUSTOMERSRetrieve a paginated list of customers. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.Connection
Retrieve a paginated list of customers. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.
Authentication
Connected account requiredTags
List invoice attachmentsMERCURY_LIST_INVOICE_ATTACHMENTSRetrieve a list of all attachments for a specific invoiceConnection
Retrieve a list of all attachments for a specific invoice
Authentication
Connected account requiredTags
List all invoicesMERCURY_LIST_INVOICESRetrieve a paginated list of invoices. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.Connection
Retrieve a paginated list of invoices. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.
Authentication
Connected account requiredTags
List merchantsMERCURY_LIST_MERCHANTSRetrieve a paginated list of priority merchants that can be used for spend controls like merchant locking. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters, plus an optional case-insensitive search by merchant name.Connection
Retrieve a paginated list of priority merchants that can be used for spend controls like merchant locking. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters, plus an optional case-insensitive search by merchant name.
Authentication
Connected account requiredTags
List recipient invitesMERCURY_LIST_RECIPIENT_INVITESRetrieve a paginated list of all recipient invites for your organization. Supports filtering by status.Connection
Retrieve a paginated list of all recipient invites for your organization. Supports filtering by status.
Authentication
Connected account requiredTags
List all recipient attachmentsMERCURY_LIST_RECIPIENTS_ATTACHMENTSRetrieve a paginated list of all recipient tax form attachments across all recipients in the organization. Use cursor parameters (start_after, end_before) for pagination.Connection
Retrieve a paginated list of all recipient tax form attachments across all recipients in the organization. Use cursor parameters (start_after, end_before) for pagination.
Authentication
Connected account requiredTags
List reimbursementsMERCURY_LIST_REIMBURSEMENTSRetrieve a paginated list of reimbursements for the organization, newest first. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.Connection
Retrieve a paginated list of reimbursements for the organization, newest first. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.
Authentication
Connected account requiredTags
List send money approval requestsMERCURY_LIST_SEND_MONEY_APPROVAL_REQUESTSRetrieve a paginated list of send money approval requests for the authenticated organization. Supports filtering by account and status.Connection
Retrieve a paginated list of send money approval requests for the authenticated organization. Supports filtering by account and status.
Authentication
Connected account requiredTags
List all transactionsMERCURY_LIST_TRANSACTIONSRetrieve a paginated list of all transactions across all accounts. Supports advanced filtering by date ranges, status, categories, and cursor-based pagination.Connection
Retrieve a paginated list of all transactions across all accounts. Supports advanced filtering by date ranges, status, categories, and cursor-based pagination.
Authentication
Connected account requiredTags
Create a Chart of Accounts TemplateMERCURY_POST_BOOKS_AGENT_COA_TEMPLATESCreate a new agent-owned Chart of Accounts template. These templates can be used when creating new Books instances for clients.Connection
Create a new agent-owned Chart of Accounts template. These templates can be used when creating new Books instances for clients.
Authentication
Connected account requiredTags
Create a Ledger TemplateMERCURY_POST_BOOKS_AGENT_LEDGER_TEMPLATESCreate a new ledger within an agent-owned Chart of Accounts template.Connection
Create a new ledger within an agent-owned Chart of Accounts template.
Authentication
Connected account requiredTags
Create multiple Journal EntriesMERCURY_POST_BOOKS_JOURNAL_ENTRIESCreate multiple Journal EntriesConnection
Create multiple Journal Entries
Authentication
Connected account requiredTags
Update a Ledger TemplateMERCURY_PUT_BOOKS_AGENT_LEDGER_TEMPLATEUpdate an existing ledger within an agent-owned Chart of Accounts template.Connection
Update an existing ledger within an agent-owned Chart of Accounts template.
Authentication
Connected account requiredTags
Bulk update journal entriesMERCURY_PUT_BOOKS_JOURNAL_ENTRIESBulk update journal entriesConnection
Bulk update journal entries
Authentication
Connected account requiredTags
Request to send moneyMERCURY_REQUEST_SEND_MONEYCreate a "request to send money" that will require approval based on your organization's approval policies.Connection
Create a "request to send money" that will require approval based on your organization's approval policies.
Authentication
Connected account requiredTags
Reveal card detailsMERCURY_REVEAL_CARD_PANRetrieve the full card number, expiration date, and CVC for a card. Available for agentic cards only.Connection
Retrieve the full card number, expiration date, and CVC for a card. Available for agentic cards only.
Authentication
Connected account requiredTags
Submit onboarding dataMERCURY_SUBMIT_ONBOARDING_DATASubmit onboarding data for applicants to pre-fill their Mercury applicationConnection
Submit onboarding data for applicants to pre-fill their Mercury application
Authentication
Connected account requiredTags
Unfreeze a cardMERCURY_UNFREEZE_CARDUnfreeze a previously frozen card, restoring it to active status.Connection
Unfreeze a previously frozen card, restoring it to active status.
Authentication
Connected account requiredTags
Update a cardMERCURY_UPDATE_CARDUpdate a card's nickname or spending limits.Connection
Update a card's nickname or spending limits.
Authentication
Connected account requiredTags
Update a customerMERCURY_UPDATE_CUSTOMERUpdate an existing customerConnection
Update an existing customer
Authentication
Connected account requiredTags
Update an invoiceMERCURY_UPDATE_INVOICEUpdate an existing invoiceConnection
Update an existing invoice
Authentication
Connected account requiredTags
Edit information about a specific recipientMERCURY_UPDATE_RECIPIENTUpdate an existing recipient's informationConnection
Update an existing recipient's information
Authentication
Connected account requiredTags
Update a reimbursementMERCURY_UPDATE_REIMBURSEMENTReplace the fields of an existing reimbursement. Only reimbursements still in review can be edited.Connection
Replace the fields of an existing reimbursement. Only reimbursements still in review can be edited.
Authentication
Connected account requiredTags
Update transaction metadataMERCURY_UPDATE_TRANSACTIONUpdate the note and/or category of an existing transaction. Use null values to clear existing data.Connection
Update the note and/or category of an existing transaction. Use null values to clear existing data.
Authentication
Connected account requiredTags
Update an existing webhook endpointMERCURY_UPDATE_WEBHOOKUpdate the configuration of an existing webhook endpoint. A webhook that has been disabled due to consecutive delivery failures can be reactivated by setting its status to 'active'.Connection
Update the configuration of an existing webhook endpoint. A webhook that has been disabled due to consecutive delivery failures can be reactivated by setting its status to 'active'.
Authentication
Connected account requiredTags
Verify a webhook endpointMERCURY_VERIFY_WEBHOOKSend a test event to verify the webhook endpoint is properly configured and reachable. The request body accepts an optional 'eventType' field to specify which event type to test (e.g., 'transaction.created', 'transaction.updated'). If omitted from the request body, defaults to 'transaction.created'.Connection
Send a test event to verify the webhook endpoint is properly configured and reachable. The request body accepts an optional 'eventType' field to specify which event type to test (e.g., 'transaction.created', 'transaction.updated'). If omitted from the request body, defaults to 'transaction.created'.
Authentication
Connected account requiredTags