Skip to content

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.

OperationTypeScriptPythonPolicy IDResponse
mercury.archivebudgetbudgets.archiveBudgetbudgets.archive_budgetmercury:archiveBudgetapplication/json
mercury.assigntransactiontobudgetbudgets.assignTransactionToBudgetbudgets.assign_transaction_to_budgetmercury:assignTransactionToBudgetapplication/json
mercury.cancelcardcards.cancelCardcards.cancel_cardmercury:cancelCardapplication/json
mercury.cancelinvoiceinvoices.cancelInvoiceinvoices.cancel_invoicemercury:cancelInvoiceapplication/json
mercury.createbudgetbudgets.createBudgetbudgets.create_budgetmercury:createBudgetapplication/json
mercury.createcardcards.createCardcards.create_cardmercury:createCardapplication/json
mercury.createcategorycategories.createCategorycategories.create_categorymercury:createCategoryapplication/json
mercury.createcustomercustomers.createCustomercustomers.create_customermercury:createCustomerapplication/json
mercury.createinternaltransferaccounts.createInternalTransferaccounts.create_internal_transfermercury:createInternalTransferapplication/json
mercury.createinvoiceinvoices.createInvoiceinvoices.create_invoicemercury:createInvoiceapplication/json
mercury.createproductproducts.createProductproducts.create_productmercury:createProductapplication/json
mercury.createreceiptuploadurlreceipts.createReceiptUploadUrlreceipts.create_receipt_upload_urlmercury:createReceiptUploadUrlapplication/json
mercury.createrecipientrecipients.createRecipientrecipients.create_recipientmercury:createRecipientapplication/json
mercury.createrecipientinviterecipientInvites.createRecipientInviterecipient_invites.create_recipient_invitemercury:createRecipientInviteapplication/json
mercury.createtransactionaccounts.createTransactionaccounts.create_transactionmercury:createTransactionapplication/json
mercury.createwebhookwebhooks.createWebhookwebhooks.create_webhookmercury:createWebhookapplication/json
mercury.deletecategorycategories.deleteCategorycategories.delete_categorymercury:deleteCategoryapplication/json
mercury.deletecustomercustomers.deleteCustomercustomers.delete_customermercury:deleteCustomerapplication/json
mercury.deleteproductproducts.deleteProductproducts.delete_productmercury:deleteProductapplication/json
mercury.deleterecipientrecipients.deleteRecipientrecipients.delete_recipientmercury:deleteRecipientapplication/json
mercury.deleterecipientinviterecipientInvites.deleteRecipientInviterecipient_invites.delete_recipient_invitemercury:deleteRecipientInviteapplication/json
mercury.deletewebhookwebhooks.deleteWebhookwebhooks.delete_webhookmercury:deleteWebhookapplication/json
mercury.editcategorycategories.editCategorycategories.edit_categorymercury:editCategoryapplication/json
mercury.freezecardcards.freezeCardcards.freeze_cardmercury:freezeCardapplication/json
mercury.getaccountcardsaccounts.getAccountCardsaccounts.get_account_cardsmercury:getAccountCardsapplication/json
mercury.getaccountsaccounts.getAccountsaccounts.get_accountsmercury:getAccountsapplication/json
mercury.getaccountstatementsaccounts.getAccountStatementsaccounts.get_account_statementsmercury:getAccountStatementsapplication/json
mercury.getattachmentinvoices.getAttachmentinvoices.get_attachmentmercury:getAttachmentapplication/json
mercury.getautotransferrulesautoTransferRules.getAutoTransferRulesauto_transfer_rules.get_auto_transfer_rulesmercury:getAutoTransferRulesapplication/json
mercury.getbudgetbudgets.getBudgetbudgets.get_budgetmercury:getBudgetapplication/json
mercury.getbudgetexpendituresbudgets.getBudgetExpendituresbudgets.get_budget_expendituresmercury:getBudgetExpendituresapplication/json
mercury.getbudgetmembersbudgets.getBudgetMembersbudgets.get_budget_membersmercury:getBudgetMembersapplication/json
mercury.getcardcards.getCardcards.get_cardmercury:getCardapplication/json
mercury.getcreditaccountstatementscredit.getCreditAccountStatementscredit.get_credit_account_statementsmercury:getCreditAccountStatementsapplication/json
mercury.getcustomercustomers.getCustomercustomers.get_customermercury:getCustomerapplication/json
mercury.geteventevents.getEventevents.get_eventmercury:getEventapplication/json
mercury.geteventsevents.getEventsevents.get_eventsmercury:getEventsapplication/json
mercury.getinvoiceinvoices.getInvoiceinvoices.get_invoicemercury:getInvoiceapplication/json
mercury.getinvoicepdfinvoices.getInvoicePdfinvoices.get_invoice_pdfmercury:getInvoicePdfapplication/pdf
mercury.getorganizationorganization.getOrganizationorganization.get_organizationmercury:getOrganizationapplication/json
mercury.getreceiptreceipts.getReceiptreceipts.get_receiptmercury:getReceiptapplication/json
mercury.getrecipientrecipients.getRecipientrecipients.get_recipientmercury:getRecipientapplication/json
mercury.getrecipientinviterecipientInvites.getRecipientInviterecipient_invites.get_recipient_invitemercury:getRecipientInviteapplication/json
mercury.getrecipientsrecipients.getRecipientsrecipients.get_recipientsmercury:getRecipientsapplication/json
mercury.getsaferequestsafes.getSafeRequestsafes.get_safe_requestmercury:getSafeRequestapplication/json
mercury.getsaferequestdocumentsafes.getSafeRequestDocumentsafes.get_safe_request_documentmercury:getSafeRequestDocumentapplication/pdf
mercury.getsaferequestssafes.getSafeRequestssafes.get_safe_requestsmercury:getSafeRequestsapplication/json
mercury.getsendmoneyapprovalrequestsendMoney.getSendMoneyApprovalRequestsend_money.get_send_money_approval_requestmercury:getSendMoneyApprovalRequestapplication/json
mercury.getstatementpdfstatements.getStatementPdfstatements.get_statement_pdfmercury:getStatementPdfapplication/pdf
mercury.gettransactionaccounts.getTransactionaccounts.get_transactionmercury:getTransactionapplication/json
mercury.gettransactionbyidtransactions.getTransactionByIdtransactions.get_transaction_by_idmercury:getTransactionByIdapplication/json
mercury.gettransfermoneyapprovalrequesttransferMoneyRequests.getTransferMoneyApprovalRequesttransfer_money_requests.get_transfer_money_approval_requestmercury:getTransferMoneyApprovalRequestapplication/json
mercury.gettreasurytreasury.getTreasurytreasury.get_treasurymercury:getTreasuryapplication/json
mercury.gettreasurystatementstreasury.getTreasuryStatementstreasury.get_treasury_statementsmercury:getTreasuryStatementsapplication/json
mercury.gettreasurytransactionstreasury.getTreasuryTransactionstreasury.get_treasury_transactionsmercury:getTreasuryTransactionsapplication/json
mercury.getuserusers.getUserusers.get_usermercury:getUserapplication/json
mercury.getusersusers.getUsersusers.get_usersmercury:getUsersapplication/json
mercury.getwebhookwebhooks.getWebhookwebhooks.get_webhookmercury:getWebhookapplication/json
mercury.getwebhookswebhooks.getWebhookswebhooks.get_webhooksmercury:getWebhooksapplication/json
mercury.listaccounttransactionsaccounts.listAccountTransactionsaccounts.list_account_transactionsmercury:listAccountTransactionsapplication/json
mercury.listbudgetsbudgets.listBudgetsbudgets.list_budgetsmercury:listBudgetsapplication/json
mercury.listcardscards.listCardscards.list_cardsmercury:listCardsapplication/json
mercury.listcategoriescategories.listCategoriescategories.list_categoriesmercury:listCategoriesapplication/json
mercury.listcreditcredit.listCreditcredit.list_creditmercury:listCreditapplication/json
mercury.listcustomerscustomers.listCustomerscustomers.list_customersmercury:listCustomersapplication/json
mercury.listinvoiceattachmentsinvoices.listInvoiceAttachmentsinvoices.list_invoice_attachmentsmercury:listInvoiceAttachmentsapplication/json
mercury.listinvoicesinvoices.listInvoicesinvoices.list_invoicesmercury:listInvoicesapplication/json
mercury.listmerchantsmerchants.listMerchantsmerchants.list_merchantsmercury:listMerchantsapplication/json
mercury.listproductsproducts.listProductsproducts.list_productsmercury:listProductsapplication/json
mercury.listreceiptsreceipts.listReceiptsreceipts.list_receiptsmercury:listReceiptsapplication/json
mercury.listrecipientinvitesrecipientInvites.listRecipientInvitesrecipient_invites.list_recipient_invitesmercury:listRecipientInvitesapplication/json
mercury.listrecipientsattachmentsrecipients.listRecipientsAttachmentsrecipients.list_recipients_attachmentsmercury:listRecipientsAttachmentsapplication/json
mercury.listsendmoneyapprovalrequestssendMoney.listSendMoneyApprovalRequestssend_money.list_send_money_approval_requestsmercury:listSendMoneyApprovalRequestsapplication/json
mercury.listtransactionstransactions.listTransactionstransactions.list_transactionsmercury:listTransactionsapplication/json
mercury.listtransfermoneyapprovalrequeststransferMoneyRequests.listTransferMoneyApprovalRequeststransfer_money_requests.list_transfer_money_approval_requestsmercury:listTransferMoneyApprovalRequestsapplication/json
mercury.matchreceiptreceipts.matchReceiptreceipts.match_receiptmercury:matchReceiptapplication/json
mercury.requestsendmoneyaccounts.requestSendMoneyaccounts.request_send_moneymercury:requestSendMoneyapplication/json
mercury.requesttransfermoneytransferMoneyRequests.requestTransferMoneytransfer_money_requests.request_transfer_moneymercury:requestTransferMoneyapplication/json
mercury.revealcardpanvault.revealCardPanvault.reveal_card_panmercury:revealCardPanapplication/json
mercury.unfreezecardcards.unfreezeCardcards.unfreeze_cardmercury:unfreezeCardapplication/json
mercury.updatebudgetbudgets.updateBudgetbudgets.update_budgetmercury:updateBudgetapplication/json
mercury.updatecardcards.updateCardcards.update_cardmercury:updateCardapplication/json
mercury.updatecustomercustomers.updateCustomercustomers.update_customermercury:updateCustomerapplication/json
mercury.updateinvoiceinvoices.updateInvoiceinvoices.update_invoicemercury:updateInvoiceapplication/json
mercury.updaterecipientrecipients.updateRecipientrecipients.update_recipientmercury:updateRecipientapplication/json
mercury.updatetransactiontransactions.updateTransactiontransactions.update_transactionmercury:updateTransactionapplication/json
mercury.updatewebhookwebhooks.updateWebhookwebhooks.update_webhookmercury:updateWebhookapplication/json
mercury.uploadrecipientattachmentrecipients.uploadRecipientAttachmentrecipients.upload_recipient_attachmentmercury:uploadRecipientAttachmentapplication/json
mercury.uploadtransactionattachmenttransactions.uploadTransactionAttachmenttransactions.upload_transaction_attachmentmercury:uploadTransactionAttachmentapplication/json
mercury.verifywebhookwebhooks.verifyWebhookwebhooks.verify_webhookmercury:verifyWebhookapplication/json

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.