Integrations
Mercury managed operation reference
Every Mercury operation, SDK method, policy identity and source
Contract 2026-11-10 exposes 90 operations. Install @alter-ai/mercury or alter-sdk-mercury and construct MercuryIntegration with the application’s core client and connection. Methods below are relative to that provider client.
See usage and versioning. Select an operation below for its complete input/output fields and Python/TypeScript examples, or browse every schema. Native OpenAPI specification for this contract: mercury.2026-11-10.openapi.json. It describes the provider’s own API; call it through the provider SDK so policy, approvals and audit apply. Earlier contracts: contract versions.
Persist a pending call’s approvalId / approval_id, then call the package client’s resume(id) after restart and await wait(). The stored provider/version must match this installed publication; its operation selects the validator. See restart-safe approvals.
| Operation | TypeScript | Python | Policy ID | Response |
|---|---|---|---|---|
| mercury.archivebudget | budgets.archiveBudget | budgets.archive_budget | mercury:archiveBudget | application/json |
| mercury.assigntransactiontobudget | budgets.assignTransactionToBudget | budgets.assign_transaction_to_budget | mercury:assignTransactionToBudget | application/json |
| mercury.cancelcard | cards.cancelCard | cards.cancel_card | mercury:cancelCard | application/json |
| mercury.cancelinvoice | invoices.cancelInvoice | invoices.cancel_invoice | mercury:cancelInvoice | application/json |
| mercury.createbudget | budgets.createBudget | budgets.create_budget | mercury:createBudget | application/json |
| mercury.createcard | cards.createCard | cards.create_card | mercury:createCard | application/json |
| mercury.createcategory | categories.createCategory | categories.create_category | mercury:createCategory | application/json |
| mercury.createcustomer | customers.createCustomer | customers.create_customer | mercury:createCustomer | application/json |
| mercury.createinternaltransfer | accounts.createInternalTransfer | accounts.create_internal_transfer | mercury:createInternalTransfer | application/json |
| mercury.createinvoice | invoices.createInvoice | invoices.create_invoice | mercury:createInvoice | application/json |
| mercury.createproduct | products.createProduct | products.create_product | mercury:createProduct | application/json |
| mercury.createreceiptuploadurl | receipts.createReceiptUploadUrl | receipts.create_receipt_upload_url | mercury:createReceiptUploadUrl | application/json |
| mercury.createrecipient | recipients.createRecipient | recipients.create_recipient | mercury:createRecipient | application/json |
| mercury.createrecipientinvite | recipientInvites.createRecipientInvite | recipient_invites.create_recipient_invite | mercury:createRecipientInvite | application/json |
| mercury.createtransaction | accounts.createTransaction | accounts.create_transaction | mercury:createTransaction | application/json |
| mercury.createwebhook | webhooks.createWebhook | webhooks.create_webhook | mercury:createWebhook | application/json |
| mercury.deletecategory | categories.deleteCategory | categories.delete_category | mercury:deleteCategory | application/json |
| mercury.deletecustomer | customers.deleteCustomer | customers.delete_customer | mercury:deleteCustomer | application/json |
| mercury.deleteproduct | products.deleteProduct | products.delete_product | mercury:deleteProduct | application/json |
| mercury.deleterecipient | recipients.deleteRecipient | recipients.delete_recipient | mercury:deleteRecipient | application/json |
| mercury.deleterecipientinvite | recipientInvites.deleteRecipientInvite | recipient_invites.delete_recipient_invite | mercury:deleteRecipientInvite | application/json |
| mercury.deletewebhook | webhooks.deleteWebhook | webhooks.delete_webhook | mercury:deleteWebhook | application/json |
| mercury.editcategory | categories.editCategory | categories.edit_category | mercury:editCategory | application/json |
| mercury.freezecard | cards.freezeCard | cards.freeze_card | mercury:freezeCard | application/json |
| mercury.getaccountcards | accounts.getAccountCards | accounts.get_account_cards | mercury:getAccountCards | application/json |
| mercury.getaccounts | accounts.getAccounts | accounts.get_accounts | mercury:getAccounts | application/json |
| mercury.getaccountstatements | accounts.getAccountStatements | accounts.get_account_statements | mercury:getAccountStatements | application/json |
| mercury.getattachment | invoices.getAttachment | invoices.get_attachment | mercury:getAttachment | application/json |
| mercury.getautotransferrules | autoTransferRules.getAutoTransferRules | auto_transfer_rules.get_auto_transfer_rules | mercury:getAutoTransferRules | application/json |
| mercury.getbudget | budgets.getBudget | budgets.get_budget | mercury:getBudget | application/json |
| mercury.getbudgetexpenditures | budgets.getBudgetExpenditures | budgets.get_budget_expenditures | mercury:getBudgetExpenditures | application/json |
| mercury.getbudgetmembers | budgets.getBudgetMembers | budgets.get_budget_members | mercury:getBudgetMembers | application/json |
| mercury.getcard | cards.getCard | cards.get_card | mercury:getCard | application/json |
| mercury.getcreditaccountstatements | credit.getCreditAccountStatements | credit.get_credit_account_statements | mercury:getCreditAccountStatements | application/json |
| mercury.getcustomer | customers.getCustomer | customers.get_customer | mercury:getCustomer | application/json |
| mercury.getevent | events.getEvent | events.get_event | mercury:getEvent | application/json |
| mercury.getevents | events.getEvents | events.get_events | mercury:getEvents | application/json |
| mercury.getinvoice | invoices.getInvoice | invoices.get_invoice | mercury:getInvoice | application/json |
| mercury.getinvoicepdf | invoices.getInvoicePdf | invoices.get_invoice_pdf | mercury:getInvoicePdf | application/pdf |
| mercury.getorganization | organization.getOrganization | organization.get_organization | mercury:getOrganization | application/json |
| mercury.getreceipt | receipts.getReceipt | receipts.get_receipt | mercury:getReceipt | application/json |
| mercury.getrecipient | recipients.getRecipient | recipients.get_recipient | mercury:getRecipient | application/json |
| mercury.getrecipientinvite | recipientInvites.getRecipientInvite | recipient_invites.get_recipient_invite | mercury:getRecipientInvite | application/json |
| mercury.getrecipients | recipients.getRecipients | recipients.get_recipients | mercury:getRecipients | application/json |
| mercury.getsaferequest | safes.getSafeRequest | safes.get_safe_request | mercury:getSafeRequest | application/json |
| mercury.getsaferequestdocument | safes.getSafeRequestDocument | safes.get_safe_request_document | mercury:getSafeRequestDocument | application/pdf |
| mercury.getsaferequests | safes.getSafeRequests | safes.get_safe_requests | mercury:getSafeRequests | application/json |
| mercury.getsendmoneyapprovalrequest | sendMoney.getSendMoneyApprovalRequest | send_money.get_send_money_approval_request | mercury:getSendMoneyApprovalRequest | application/json |
| mercury.getstatementpdf | statements.getStatementPdf | statements.get_statement_pdf | mercury:getStatementPdf | application/pdf |
| mercury.gettransaction | accounts.getTransaction | accounts.get_transaction | mercury:getTransaction | application/json |
| mercury.gettransactionbyid | transactions.getTransactionById | transactions.get_transaction_by_id | mercury:getTransactionById | application/json |
| mercury.gettransfermoneyapprovalrequest | transferMoneyRequests.getTransferMoneyApprovalRequest | transfer_money_requests.get_transfer_money_approval_request | mercury:getTransferMoneyApprovalRequest | application/json |
| mercury.gettreasury | treasury.getTreasury | treasury.get_treasury | mercury:getTreasury | application/json |
| mercury.gettreasurystatements | treasury.getTreasuryStatements | treasury.get_treasury_statements | mercury:getTreasuryStatements | application/json |
| mercury.gettreasurytransactions | treasury.getTreasuryTransactions | treasury.get_treasury_transactions | mercury:getTreasuryTransactions | application/json |
| mercury.getuser | users.getUser | users.get_user | mercury:getUser | application/json |
| mercury.getusers | users.getUsers | users.get_users | mercury:getUsers | application/json |
| mercury.getwebhook | webhooks.getWebhook | webhooks.get_webhook | mercury:getWebhook | application/json |
| mercury.getwebhooks | webhooks.getWebhooks | webhooks.get_webhooks | mercury:getWebhooks | application/json |
| mercury.listaccounttransactions | accounts.listAccountTransactions | accounts.list_account_transactions | mercury:listAccountTransactions | application/json |
| mercury.listbudgets | budgets.listBudgets | budgets.list_budgets | mercury:listBudgets | application/json |
| mercury.listcards | cards.listCards | cards.list_cards | mercury:listCards | application/json |
| mercury.listcategories | categories.listCategories | categories.list_categories | mercury:listCategories | application/json |
| mercury.listcredit | credit.listCredit | credit.list_credit | mercury:listCredit | application/json |
| mercury.listcustomers | customers.listCustomers | customers.list_customers | mercury:listCustomers | application/json |
| mercury.listinvoiceattachments | invoices.listInvoiceAttachments | invoices.list_invoice_attachments | mercury:listInvoiceAttachments | application/json |
| mercury.listinvoices | invoices.listInvoices | invoices.list_invoices | mercury:listInvoices | application/json |
| mercury.listmerchants | merchants.listMerchants | merchants.list_merchants | mercury:listMerchants | application/json |
| mercury.listproducts | products.listProducts | products.list_products | mercury:listProducts | application/json |
| mercury.listreceipts | receipts.listReceipts | receipts.list_receipts | mercury:listReceipts | application/json |
| mercury.listrecipientinvites | recipientInvites.listRecipientInvites | recipient_invites.list_recipient_invites | mercury:listRecipientInvites | application/json |
| mercury.listrecipientsattachments | recipients.listRecipientsAttachments | recipients.list_recipients_attachments | mercury:listRecipientsAttachments | application/json |
| mercury.listsendmoneyapprovalrequests | sendMoney.listSendMoneyApprovalRequests | send_money.list_send_money_approval_requests | mercury:listSendMoneyApprovalRequests | application/json |
| mercury.listtransactions | transactions.listTransactions | transactions.list_transactions | mercury:listTransactions | application/json |
| mercury.listtransfermoneyapprovalrequests | transferMoneyRequests.listTransferMoneyApprovalRequests | transfer_money_requests.list_transfer_money_approval_requests | mercury:listTransferMoneyApprovalRequests | application/json |
| mercury.matchreceipt | receipts.matchReceipt | receipts.match_receipt | mercury:matchReceipt | application/json |
| mercury.requestsendmoney | accounts.requestSendMoney | accounts.request_send_money | mercury:requestSendMoney | application/json |
| mercury.requesttransfermoney | transferMoneyRequests.requestTransferMoney | transfer_money_requests.request_transfer_money | mercury:requestTransferMoney | application/json |
| mercury.revealcardpan | vault.revealCardPan | vault.reveal_card_pan | mercury:revealCardPan | application/json |
| mercury.unfreezecard | cards.unfreezeCard | cards.unfreeze_card | mercury:unfreezeCard | application/json |
| mercury.updatebudget | budgets.updateBudget | budgets.update_budget | mercury:updateBudget | application/json |
| mercury.updatecard | cards.updateCard | cards.update_card | mercury:updateCard | application/json |
| mercury.updatecustomer | customers.updateCustomer | customers.update_customer | mercury:updateCustomer | application/json |
| mercury.updateinvoice | invoices.updateInvoice | invoices.update_invoice | mercury:updateInvoice | application/json |
| mercury.updaterecipient | recipients.updateRecipient | recipients.update_recipient | mercury:updateRecipient | application/json |
| mercury.updatetransaction | transactions.updateTransaction | transactions.update_transaction | mercury:updateTransaction | application/json |
| mercury.updatewebhook | webhooks.updateWebhook | webhooks.update_webhook | mercury:updateWebhook | application/json |
| mercury.uploadrecipientattachment | recipients.uploadRecipientAttachment | recipients.upload_recipient_attachment | mercury:uploadRecipientAttachment | application/json |
| mercury.uploadtransactionattachment | transactions.uploadTransactionAttachment | transactions.upload_transaction_attachment | mercury:uploadTransactionAttachment | application/json |
| mercury.verifywebhook | webhooks.verifyWebhook | webhooks.verify_webhook | mercury:verifyWebhook | application/json |