Mercury

Read Mercury accounts and transactions, manage recipients and cards, send payments for approval, and raise invoices.

Triggers

Start a workflow when something happens in Mercury. See how triggers work.

New Mercury transaction

Runs when a new transaction appears in Mercury. Optionally limit it to a single account.

Filters

Narrow which events start a run.

account_id

Event fields

What a run starts with. Later steps read each field with an @ reference.

id: The transaction's ID.
accountId: The Mercury account the transaction belongs to.
amount: Amount in dollars - negative for debits, positive for credits.
status: pending, sent, cancelled, failed, reversed or blocked.
kind: What kind of transaction it is, for example externalTransfer.
counterpartyName: Who the money went to or came from.
note: Internal note, if one is set.
externalMemo: Memo shown to the counterparty.
postedAt: When the transaction posted.
createdAt: When the transaction was created.
dashboardLink: Link to the transaction in Mercury.

Actions

Action	What it does
Attach file to Mercury transaction	Upload a receipt or supporting document to a transaction.
Cancel Mercury card	Permanently cancel a card.
Cancel Mercury invoice	Cancel an invoice so it can no longer be paid.
Create Mercury category	Create a custom expense category.
Create Mercury customer	Add a customer you can then invoice.
Create Mercury invoice	Raise an invoice against a customer and have Mercury collect it.
Create Mercury recipient	Add a payment recipient.
Create Mercury recipient invite	Invite someone to submit their own payment details, so you never handle their bank information.
Delete Mercury category	Delete a custom expense category.
Delete Mercury customer	Delete an invoicing customer.
Delete Mercury recipient	Delete a recipient.
Delete Mercury recipient invite	Revoke an outstanding recipient invite.
Download Mercury invoice PDF	Fetch an invoice's PDF and report its size.
Download Mercury SAFE document	Fetch the signed PDF for a SAFE request and report its size.
Download Mercury statement PDF	Fetch a statement PDF and report its size.
Freeze Mercury card	Temporarily freeze an active card so it declines new charges.
Get Mercury account	Get one Mercury account's details and current balances.
Get Mercury card	Get one card's details, spend limits and category locks.
Get Mercury customer	Get one invoicing customer's details.
Get Mercury event	Get one change-log event, including its before and after values.
Get Mercury invoice	Get one invoice in full, including its line items.
Get Mercury invoice attachment	Get one invoice attachment's details and signed download URL.
Get Mercury organization	Get the organization's legal business name, EIN and any DBAs - useful for filling invoices and compliance paperwork.
Get Mercury payment approval request	Check whether one payment approval request has been approved yet.
Get Mercury recipient	Get one recipient's details, routing info and tax-form attachments.
Get Mercury SAFE request	Get one SAFE request's full details.
Get Mercury transaction	Get one transaction in full, including attachments, merchant details and any accounting-software GL allocations.
Get Mercury user	Get one Mercury user's name, email and role.
Issue Mercury virtual card	Issue a new virtual card to a user, optionally with a spend limit.
List Mercury accounts	List every Mercury account - checking, savings and treasury - with current and available balances.
List Mercury cards	List corporate cards with their status, cardholder, last four digits and current spend limits.
List Mercury categories	List the organization's custom expense categories, for tagging transactions.
List Mercury credit accounts	List the organization's Mercury credit accounts and their limits.
List Mercury customers	List the customers you can invoice.
List Mercury events	Read Mercury's change log for transactions and account balances.
List Mercury invoice attachments	List the files attached to an invoice.
List Mercury invoices	List accounts-receivable invoices with their status, amount and customer.
List Mercury payment approval requests	List payment requests awaiting approval, with their current status.
List Mercury recipient attachments	List recipient tax-form attachments (W-9, W-8BEN and similar) across the organization, or for one recipient.
List Mercury recipient invites	List outstanding invites asking recipients for their payment details.
List Mercury recipients	List saved payment recipients with their default payment method and routing details.
List Mercury SAFE requests	List SAFE (Simple Agreement for Future Equity) requests raised through Mercury, with investor and valuation details.
List Mercury statements	List an account's monthly statements, each with a download URL and opening/closing balances.
List Mercury transactions	List transactions across every account, with filters for account, card, status, category, free-text search and date range.
List Mercury treasury accounts	List treasury accounts with balances and net returns, for tracking yield on idle cash.
List Mercury treasury statements	List statements for a treasury account.
List Mercury treasury transactions	List the activity on a treasury account.
List Mercury users	List the people on the Mercury account with their roles.
Request Mercury payment approval	Create a payment request that follows your organization's own Mercury approval rules instead of sending money immediately.
Send Mercury money	Send an ACH, domestic wire or paper check to a saved recipient.
Transfer between Mercury accounts	Move money between two accounts in the same Mercury organization, for example sweeping checking into savings.
Unfreeze Mercury card	Return a frozen card to active so it accepts charges again.
Update Mercury card	Rename a card or change its spend limit.
Update Mercury category	Rename a custom expense category.
Update Mercury customer	Change a customer's name, email or billing address.
Update Mercury invoice	Change an invoice's line items, dates or memos before it is paid.
Update Mercury recipient	Change a recipient's name, emails or routing details.
Update Mercury transaction	Set or clear a transaction's internal note and custom category.
Upload Mercury recipient tax form	Upload a tax form for a recipient.

Attach file to Mercury transaction

Upload a receipt or supporting document to a transaction. Accepts a file upload or a document produced by an earlier step.

Inputs

Transaction IDtransaction_idtextRequired: The transaction to attach the file to.
FilefilelistRequired: The receipt or document to attach.
File namefile_nametext: Name to store the file under.

Outputs

fileNametext
idtext: Attachment ID.
urltext: Signed download URL for the stored file.

Example output

{
  "fileName": "aws-september-receipt.pdf",
  "id": "att-3333-4eee-8fff-000000000003",
  "url": "https://mercury.com/attachments/signed-url"
}

Cancel Mercury card

Permanently cancel a card. This cannot be undone - use Freeze Mercury card for a reversible block. Needs a read-and-write API token.

Inputs

Card IDcard_idtextRequired: The card to cancel permanently.

Outputs

idtext
statustext: Becomes cancelled.

Example output

{
  "id": "card-4444-4aaa-9bbb-000000000004",
  "status": "cancelled"
}

Cancel Mercury invoice

Cancel an invoice so it can no longer be paid. This cannot be undone. Needs a read-and-write API token.

Inputs

Invoice IDinvoice_idtextRequired: The invoice to cancel.

Outputs

cancelledtrue/false: True when the call succeeded.
invoice_idtext: The affected resource's ID.

Example output

{
  "cancelled": true,
  "invoice_id": "inv-1717-4bbb-8ccc-000000000017"
}

Create Mercury category

Create a custom expense category. Needs a read-and-write API token.

Inputs

NamenametextRequired: Name of the new category, for example 'Cloud Infrastructure'.
Offer for card spendvisible_for_card_spendtrue/false: Offer this category on card transactions. Default is true.Default: true.
Offer for reimbursementsvisible_for_reimbursementstrue/false: Offer this category on reimbursements. Default is true.Default: true.
Offer for other transactionsvisible_for_othertrue/false: Offer this category on all other transactions. Default is true.Default: true.

Outputs

idtext: Category ID. Use as category_id in Update Mercury transaction.
nametext

Example output

{
  "id": "cat-ffff-4666-8777-00000000000f",
  "name": "Cloud Infrastructure"
}

Create Mercury customer

Add a customer you can then invoice. Needs a read-and-write API token.

Inputs

NamenametextRequired: Customer's name as it should appear on invoices.
EmailemailtextRequired: Where Mercury sends their invoices.
Addressaddressobject: Billing address, with fields line1, line2, city, region, postalCode and country.

Outputs

addressobject: Billing address, if set.
deletedAttext: Set once the customer has been deleted.
emailtext
idtext: Customer ID. Use as customer_id when creating an invoice.
nametext

Example output

{
  "email": "ap@northwind.example",
  "id": "cust-1818-4ccc-8ddd-000000000018",
  "name": "Northwind Design LLC"
}

Create Mercury invoice

Raise an invoice against a customer and have Mercury collect it. Needs a read-and-write API token.

Inputs

Customercustomer_idtextRequired: Who to invoice. Create one first with Create Mercury customer.
Deposit intodestination_account_idtextRequired: Account the payment should land in.
Line itemsline_itemslistRequired: The things being billed. Each item has name, quantity, unitPrice and optionally salesTaxRate.
Due datedue_datedateRequired: When payment is due.
Invoice dateinvoice_datedate: Date shown on the invoice - often when the work was done rather than today. Default is today.
Invoice numberinvoice_numbertext: Your own invoice number. Mercury assigns one if omitted.
Currency codecurrency_codetext: ISO 4217 currency code, for example USD.Default: USD.
CC emailscc_emailslist: Additional addresses to copy on invoice notifications.
Payer memopayer_memotext: Message shown to the payer on the invoice.
Internal noteinternal_notetext: Note visible to your team only, not to the payer.
PO numberpo_numbertext: Purchase order number, if the customer requires one.
Allow ACH debitach_debit_enabledtrue/false: Let the customer pay by ACH debit. Default is false.Default: false.
Allow card paymentcredit_card_enabledtrue/false: Let the customer pay by credit card. Default is false.Default: false.
Show real account numberuse_real_account_numbertrue/false: Show the deposit account's real account number on the invoice. Default is false.Default: false.

Outputs

amountnumber: Line-item total plus taxes, in dollars.
currencyCodetext
customerIdtext
destinationAccountIdtext
dueDatetext: YYYY-MM-DD.
idtext: Invoice ID.
internalNotetext
invoiceDatetext: YYYY-MM-DD.
invoiceNumbertext
lineItemslist
payerMemotext
slugtext: Public slug used to build the pay-page and PDF URLs.
statustext: Unpaid, Paid, Processing or Cancelled.

Example output

{
  "amount": 4800.0,
  "dueDate": "2026-10-01",
  "id": "inv-1717-4bbb-8ccc-000000000017",
  "invoiceNumber": "2026-0042",
  "slug": "inv-northwind-0042",
  "status": "Unpaid"
}

Add a payment recipient. Supply at least one set of routing details for the method you intend to pay by, or use Create Mercury recipient invite to have them fill it in. Needs a read-and-write API token.

Inputs

NamenametextRequired: Recipient's legal or business name.
EmailsemailslistRequired: Email addresses Mercury notifies about payments.
Contact emailcontact_emailtext: Primary contact email, if different from the above.
Nicknamenicknametext: Short internal label for the recipient.
ACH detailselectronic_routing_infoobject: Bank details for ACH payments, with fields: accountNumber, routingNumber, electronicAccountType (businessChecking, businessSavings, personalChecking or personalSavings), and the account holder's address: an address object (address1, optional address2, city, region, postalCode, country; for example US). All are required.
Wire detailsdomestic_wire_routing_infoobject: Bank details for domestic wires, with fields: accountNumber, routingNumber, and the account holder's address: an address object (address1, optional address2, city, region, postalCode, country; for example US). All are required.
Check detailscheck_infoobject: Mailing details for paper checks: an address object (address1, optional address2, city, region, postalCode, country; for example US), under the key address.

Outputs

checkInfoobject
dateLastPaidtext
defaultPaymentMethodtext: ach, check, domesticWire, internationalWire or realTimePayment.
domesticWireRoutingInfoobject
electronicRoutingInfoobject
emailslist
idtext: Recipient ID. Use as recipient_id when sending money.
nametext
nicknametext
statustext: active or deleted.

Example output

{
  "defaultPaymentMethod": "ach",
  "emails": [
    "ap@northwind.example"
  ],
  "id": "rcpt-bbbb-4222-8333-00000000000b",
  "name": "Northwind Design LLC",
  "status": "active"
}

Create Mercury recipient invite

Invite someone to submit their own payment details, so you never handle their bank information. Pick an existing recipient to have them complete that record, or leave it empty to create a new one. Returns an onboarding link to share if you choose not to email the invite. Needs a read-and-write API token.

Inputs

EmailemailtextRequired: Email address of the person being invited.
Existing recipientrecipient_idtext: Invite an existing recipient to fill in their details. Leave empty to invite someone new.
Namenametext: Name of the person or business being invited.
Payment methodspayment_methodslist: Ways the invitee may choose to be paid: ach, check, domesticWire, internationalWire or realTimePayment. Default is ach.
Ask for a tax formrequire_tax_documenttrue/false: Ask the invitee to upload a tax form. Default is false.Default: false.
Email the invitesend_emailtrue/false: Have Mercury email the invite. Turn off to share the returned onboarding link yourself. Default is true.Default: true.

Outputs

contactEmailtext
expiresAttext
idtext: Invite ID.
onboardingUrltext: Link the invitee opens to enter their details.
paymentMethodslist
recipientIdtext
requireTaxDocumenttrue/false
statustext

Example output

{
  "contactEmail": "ap@northwind.example",
  "expiresAt": "2026-10-30T00:00:00Z",
  "id": "inv-eeee-4555-8666-00000000000e",
  "onboardingUrl": "https://app.mercury.com/invite/inv-eeee",
  "paymentMethods": [
    "ach"
  ],
  "recipientId": null,
  "requireTaxDocument": false,
  "status": "pending"
}

Delete Mercury category

Delete a custom expense category. Needs a read-and-write API token.

Inputs

Categorycategory_idtextRequired: The category to delete.

Outputs

category_idtext: The affected resource's ID.
deletedtrue/false: True when the call succeeded.

Example output

{
  "category_id": "cat-ffff-4666-8777-00000000000f",
  "deleted": true
}

Delete Mercury customer

Delete an invoicing customer. This cannot be undone. Needs a read-and-write API token.

Inputs

Customer IDcustomer_idtextRequired: The customer to delete.

Outputs

customer_idtext: The affected resource's ID.
deletedtrue/false: True when the call succeeded.

Example output

{
  "customer_id": "cust-1818-4ccc-8ddd-000000000018",
  "deleted": true
}

Delete Mercury recipient

Delete a recipient. Mercury refuses if scheduled or pending payments still reference them. Needs a read-and-write API token.

Inputs

Recipientrecipient_idtextRequired: The recipient to delete.

Outputs

deletedtrue/false: True when the call succeeded.
recipient_idtext: The affected resource's ID.

Example output

{
  "deleted": true,
  "recipient_id": "rcpt-aaaa-4111-8222-00000000000a"
}

Delete Mercury recipient invite

Revoke an outstanding recipient invite. Needs a read-and-write API token.

Inputs

Invite IDinvite_idtextRequired: The invite to revoke.

Outputs

deletedtrue/false: True when the call succeeded.
invite_idtext: The affected resource's ID.

Example output

{
  "deleted": true,
  "invite_id": "inv-eeee-4555-8666-00000000000e"
}

Download Mercury invoice PDF

Fetch an invoice's PDF and report its size.

Inputs

Invoice IDinvoice_idtextRequired: The invoice whose PDF to download.

Outputs

content_typetext: Always application/pdf.
invoice_idtext: The requested resource's ID.
size_bytesnumber: Size of the downloaded PDF in bytes.

Example output

{
  "content_type": "application/pdf",
  "invoice_id": "inv-1717-4bbb-8ccc-000000000017",
  "size_bytes": 22841
}

Download Mercury SAFE document

Fetch the signed PDF for a SAFE request and report its size.

Inputs

SAFE requestsafe_request_idtextRequired: The SAFE request whose document to download.

Outputs

content_typetext: Always application/pdf.
safe_request_idtext: The requested resource's ID.
size_bytesnumber: Size of the downloaded PDF in bytes.

Example output

{
  "content_type": "application/pdf",
  "safe_request_id": "safe-1212-4ccc-8ddd-000000000012",
  "size_bytes": 91204
}

Download Mercury statement PDF

Fetch a statement PDF and report its size. Use the statement's downloadUrl with an HTTP step if you need the file contents themselves.

Inputs

Statement IDstatement_idtextRequired: The statement to download.

Outputs

content_typetext: Always application/pdf.
size_bytesnumber: Size of the downloaded PDF in bytes.
statement_idtext: The requested resource's ID.

Example output

{
  "content_type": "application/pdf",
  "size_bytes": 48211,
  "statement_id": "stmt-7777-4ddd-8eee-000000000007"
}

Freeze Mercury card

Temporarily freeze an active card so it declines new charges. Reversible with Unfreeze Mercury card. Needs a read-and-write API token.

Inputs

Card IDcard_idtextRequired: The active card to freeze.

Outputs

idtext
statustext: Becomes frozen.

Example output

{
  "id": "card-4444-4aaa-9bbb-000000000004",
  "status": "frozen"
}

Get Mercury account

Get one Mercury account's details and current balances.

Inputs

Accountaccount_idtextRequired: Which account to look up.

Outputs

accountNumbertext
availableBalancenumber: Spendable balance in dollars.
currentBalancenumber: Balance in dollars, including pending activity.
dashboardLinktext
idtext: Account ID (UUID).
kindtext: checking, savings, …
legalBusinessNametext
nametext
nicknametext
routingNumbertext
statustext: active, deleted, pending, or archived.
typetext: mercury, external, or recipient.

Example output

{
  "availableBalance": 126100.0,
  "currentBalance": 128450.22,
  "id": "8f2c1d4e-1111-4aaa-9bbb-000000000001",
  "kind": "checking",
  "name": "Mercury Checking",
  "nickname": "Operating",
  "status": "active",
  "type": "mercury"
}

Get Mercury card

Get one card's details, spend limits and category locks.

Inputs

Card IDcard_idtextRequired: The card to fetch. Use the id from List Mercury cards.

Outputs

accountIdtext
categoryLockslist
expirationobject: {month, year}.
idtext
isAgentCardtrue/false
kindtext: debit or credit.
lastFourtext
nameOnCardtext
nicknametext
spendLimitobject: {amountCents, interval} - amountCents is cents, not dollars.
statustext: active, frozen, cancelled, inactive, expired or suspended.
typetext: virtual or physical.
userIdtext

Example output

{
  "id": "card-4444-4aaa-9bbb-000000000004",
  "kind": "debit",
  "lastFour": "4242",
  "nickname": "AWS vendor card",
  "spendLimit": {
    "amountCents": 500000,
    "interval": "monthly"
  },
  "status": "active",
  "type": "virtual"
}

Get Mercury customer

Get one invoicing customer's details.

Inputs

Customer IDcustomer_idtextRequired: The customer to fetch.

Outputs

addressobject: Billing address, if set.
deletedAttext: Set once the customer has been deleted.
emailtext
idtext: Customer ID. Use as customer_id when creating an invoice.
nametext

Example output

{
  "email": "ap@northwind.example",
  "id": "cust-1818-4ccc-8ddd-000000000018",
  "name": "Northwind Design LLC"
}

Get Mercury event

Get one change-log event, including its before and after values.

Inputs

Event IDevent_idtextRequired: The event to fetch.

Outputs

changedPathslist
idtext
mergePatchobject: The fields that changed, with their new values.
occurredAttext
operationTypetext: create, update or delete.
previousValuesobject: The same fields with their prior values.
resourceIdtext
resourceTypetext
resourceVersionnumber

Example output

{
  "changedPaths": [
    "transaction.status"
  ],
  "id": "evt-1313-4ddd-8eee-000000000013",
  "mergePatch": {
    "status": "sent"
  },
  "operationType": "update",
  "previousValues": {
    "status": "pending"
  },
  "resourceType": "transaction"
}

Get Mercury invoice

Get one invoice in full, including its line items.

Inputs

Invoice IDinvoice_idtextRequired: The invoice to fetch.

Outputs

amountnumber: Line-item total plus taxes, in dollars.
currencyCodetext
customerIdtext
destinationAccountIdtext
dueDatetext: YYYY-MM-DD.
idtext: Invoice ID.
internalNotetext
invoiceDatetext: YYYY-MM-DD.
invoiceNumbertext
lineItemslist
payerMemotext
slugtext: Public slug used to build the pay-page and PDF URLs.
statustext: Unpaid, Paid, Processing or Cancelled.

Example output

{
  "amount": 4800.0,
  "dueDate": "2026-10-01",
  "id": "inv-1717-4bbb-8ccc-000000000017",
  "invoiceNumber": "2026-0042",
  "status": "Unpaid"
}

Get Mercury invoice attachment

Get one invoice attachment's details and signed download URL.

Inputs

Attachment IDattachment_idtextRequired: The attachment to fetch.

Outputs

fileNametext
idtext
urltext: Signed URL for downloading the file.

Example output

{
  "fileName": "statement-of-work.pdf",
  "id": "iatt-1919-4ddd-8eee-000000000019",
  "url": "https://mercury.com/attachments/signed-url"
}

Get Mercury organization

Get the organization's legal business name, EIN and any DBAs - useful for filling invoices and compliance paperwork.

Inputs

None.

Outputs

organizationobject: Organization details including legalBusinessName, ein and dbas.

Example output

{
  "organization": {
    "dbas": [
      "Lodol"
    ],
    "ein": "88-1234567",
    "legalBusinessName": "Lodol Technologies Inc."
  }
}

Get Mercury payment approval request

Check whether one payment approval request has been approved yet.

Inputs

Request IDrequest_idtextRequired: The approval request to check. Use the id returned by Request Mercury payment approval.

Outputs

amountnumber: Amount in dollars.
recipientIdtext
requestIdtext
statustext: Where the request sits in the approval flow.

Example output

{
  "amount": 2500.0,
  "requestId": "req-1414-4eee-8fff-000000000014",
  "status": "pending"
}

Get Mercury recipient

Get one recipient's details, routing info and tax-form attachments.

Inputs

Recipientrecipient_idtextRequired: The recipient to fetch.

Outputs

checkInfoobject
dateLastPaidtext
defaultPaymentMethodtext: ach, check, domesticWire, internationalWire or realTimePayment.
domesticWireRoutingInfoobject
electronicRoutingInfoobject
emailslist
idtext: Recipient ID. Use as recipient_id when sending money.
nametext
nicknametext
statustext: active or deleted.

Example output

{
  "defaultPaymentMethod": "ach",
  "emails": [
    "ap@northwind.example"
  ],
  "id": "rcpt-aaaa-4111-8222-00000000000a",
  "name": "Northwind Design LLC",
  "status": "active"
}

Get Mercury SAFE request

Get one SAFE request's full details.

Inputs

SAFE requestsafe_request_idtextRequired: The SAFE request to fetch.

Outputs

amountnumber: Investment in dollars.
idtext
statustext
valuationTypetext: PreMoney, PostMoney or NoValuation.

Example output

{
  "amount": 250000.0,
  "id": "safe-1212-4ccc-8ddd-000000000012",
  "status": "pending",
  "valuationType": "PostMoney"
}

Get Mercury transaction

Get one transaction in full, including attachments, merchant details and any accounting-software GL allocations.

Inputs

Transaction IDtransaction_idtextRequired: The transaction to fetch. Use the id from List Mercury transactions.

Outputs

accountIdtext
amountnumber: Dollars; negative for debits.
attachmentslist
bankDescriptiontext
cardIdtext: Set on card payments and refunds only.
counterpartyNametext
counterpartyNicknametext
createdAttext
dashboardLinktext
estimatedDeliveryDatetext
externalMemotext
glAllocationslist
idtext
kindtext
merchantobject: Card transactions only. amount here is the merchant currency's smallest unit (divide by 100 for most currencies, 1 for JPY, 1000 for BHD/KWD/OMR).
notetext
postedAttext
statustext

Example output

{
  "amount": -89.99,
  "attachments": [],
  "counterpartyName": "Amazon Web Services",
  "id": "1a2b3c4d-2222-4ccc-8ddd-000000000002",
  "kind": "debitCardTransaction",
  "status": "sent"
}

Get Mercury user

Get one Mercury user's name, email and role.

Inputs

Useruser_idtextRequired: The user to look up.

Outputs

emailtext
firstNametext
lastNametext
organizationRoletext: administrator, bookkeeper, customUser, cardOnlyUser or employee.
userIdtext

Example output

{
  "email": "alex@example.com",
  "firstName": "Alex",
  "lastName": "Rivera",
  "organizationRole": "administrator",
  "userId": "user-5555-4bbb-8ccc-000000000005"
}

Issue Mercury virtual card

Issue a new virtual card to a user, optionally with a spend limit. Mercury only issues virtual cards through the API - order physical cards from the dashboard. Needs a read-and-write API token.

Inputs

Cardholderuser_idtextRequired: The Mercury user who will hold the card.
Card typecard_kindtextRequired: Whether to issue a debit or credit card.One of: debit (Debit (draws on an account)), credit (Credit (draws on your credit line)).
Accountaccount_idtext: Account the card draws on. Required for debit cards.
Nicknamenicknametext: Label for the card, for example 'AWS vendor card'.
Spend limitspend_limit_amountnumber: Maximum spend per interval, in dollars. Leave empty for no card-level limit.At least 0.01.
Limit resetsspend_limit_intervaltext: How often the spend limit resets.One of: daily (Per day), weekly (Per week), monthly (Per month), yearly (Per year).

Outputs

idtext: New card ID.
kindtext
lastFourtext
nicknametext
spendLimitobject
statustext: Usually active.
typetext: Always virtual.

Example output

{
  "id": "card-6666-4ccc-8ddd-000000000006",
  "kind": "debit",
  "lastFour": "1881",
  "nickname": "AWS vendor card",
  "status": "active",
  "type": "virtual"
}

List Mercury accounts

List every Mercury account - checking, savings and treasury - with current and available balances.

Inputs

Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Mercury accounts. Each has id, name, nickname, accountNumber, routingNumber, currentBalance, availableBalance (all amounts in dollars), kind, type and status.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "accountNumber": "202212783812",
      "availableBalance": 126100.0,
      "currentBalance": 128450.22,
      "id": "8f2c1d4e-1111-4aaa-9bbb-000000000001",
      "kind": "checking",
      "name": "Mercury Checking",
      "nickname": "Operating",
      "routingNumber": "084106768",
      "status": "active",
      "type": "mercury"
    }
  ],
  "next_cursor": "8f2c1d4e-1111-4aaa-9bbb-000000000001"
}

List Mercury cards

List corporate cards with their status, cardholder, last four digits and current spend limits.

Inputs

Accountaccount_idtext: Only include cards on these accounts.
Cardholderuser_idtext: Only include cards belonging to this user.
Statusstatuslist: Only include cards in these states.One or more of: active, frozen, cancelled, inactive, expired, suspended.
Agent cards onlyis_agent_cardtrue/false: Limit to cards managed by Mercury's agentic spend agent.
Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Mercury cards. Each has id, accountId, userId, nameOnCard, nickname, lastFour, kind (debit/credit), type (virtual/physical), status, expiration, isAgentCard and spendLimit. spendLimit.amountCents is in cents, not dollars.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "accountId": "8f2c1d4e-1111-4aaa-9bbb-000000000001",
      "id": "card-4444-4aaa-9bbb-000000000004",
      "isAgentCard": false,
      "kind": "debit",
      "lastFour": "4242",
      "nameOnCard": "Alex Rivera",
      "nickname": "AWS vendor card",
      "spendLimit": {
        "amountCents": 500000,
        "interval": "monthly"
      },
      "status": "active",
      "type": "virtual",
      "userId": "user-5555-4bbb-8ccc-000000000005"
    }
  ],
  "next_cursor": "card-4444-4aaa-9bbb-000000000004"
}

List Mercury categories

List the organization's custom expense categories, for tagging transactions.

Inputs

Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Custom expense categories. Each has id and name.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "id": "cat-ffff-4666-8777-00000000000f",
      "name": "Cloud Infrastructure"
    }
  ],
  "next_cursor": "cat-ffff-4666-8777-00000000000f"
}

List Mercury credit accounts

List the organization's Mercury credit accounts and their limits.

Inputs

None.

Outputs

itemslist: Credit accounts, each with id, balances and credit limit.

Example output

{
  "items": [
    {
      "creditLimit": 100000.0,
      "currentBalance": 14200.0,
      "id": "cred-1111-4bbb-8ccc-000000000011",
      "status": "active"
    }
  ]
}

List Mercury customers

List the customers you can invoice.

Inputs

Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Invoicing customers. Each has id, name, email and an optional address.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "email": "ap@northwind.example",
      "id": "cust-1818-4ccc-8ddd-000000000018",
      "name": "Northwind Design LLC"
    }
  ],
  "next_cursor": "cust-1818-4ccc-8ddd-000000000018"
}

List Mercury events

Read Mercury's change log for transactions and account balances. Each event records what changed, with before and after values - useful for reconciliation, backfills and audit trails.

Inputs

Resource typeresource_typetext: Only include events about this kind of resource.One of: transaction, checkingAccount (Checking account), savingsAccount (Savings account), treasuryAccount (Treasury account), investmentAccount (Investment account), creditAccount (Credit account).
Resource IDresource_idtext: Only include events about one specific resource ID.
Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Events, oldest first by default. Each has id, resourceType, resourceId, operationType (create/update/delete), occurredAt, resourceVersion, changedPaths, mergePatch (new values) and previousValues.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "changedPaths": [],
      "id": "evt-1313-4ddd-8eee-000000000013",
      "occurredAt": "2026-09-10T14:01:58Z",
      "operationType": "create",
      "resourceId": "1a2b3c4d-2222-4ccc-8ddd-000000000002",
      "resourceType": "transaction",
      "resourceVersion": 1
    }
  ],
  "next_cursor": "evt-1313-4ddd-8eee-000000000013"
}

List Mercury invoice attachments

List the files attached to an invoice.

Inputs

Invoice IDinvoice_idtextRequired: The invoice whose attachments to list.

Outputs

itemslist: Invoice attachments, each with id, fileName and a signed url.

Example output

{
  "items": [
    {
      "fileName": "statement-of-work.pdf",
      "id": "iatt-1919-4ddd-8eee-000000000019",
      "url": "https://mercury.com/attachments/signed-url"
    }
  ]
}

List Mercury invoices

List accounts-receivable invoices with their status, amount and customer.

Inputs

Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Invoices. Each has id, invoiceNumber, amount (dollars), status, customerId, dueDate, lineItems and slug.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "amount": 4800.0,
      "customerId": "cust-1818-4ccc-8ddd-000000000018",
      "dueDate": "2026-10-01",
      "id": "inv-1717-4bbb-8ccc-000000000017",
      "invoiceNumber": "2026-0042",
      "status": "Unpaid"
    }
  ],
  "next_cursor": "inv-1717-4bbb-8ccc-000000000017"
}

List Mercury payment approval requests

List payment requests awaiting approval, with their current status. Pair this with Request Mercury payment approval to track what is still pending.

Inputs

Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Send-money approval requests. Each has requestId, status, amount (dollars), recipientId and the requesting account.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "amount": 2500.0,
      "recipientId": "rcpt-aaaa-4111-8222-00000000000a",
      "requestId": "req-1414-4eee-8fff-000000000014",
      "status": "pending"
    }
  ],
  "next_cursor": "req-1414-4eee-8fff-000000000014"
}

List Mercury recipient attachments

List recipient tax-form attachments (W-9, W-8BEN and similar) across the organization, or for one recipient.

Inputs

Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Recipient attachments. Each has id, recipientId, fileName, formType, uploadedAt and a signed url.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "fileName": "northwind-w9.pdf",
      "formType": "W9",
      "id": "ratt-cccc-4333-8444-00000000000c",
      "recipientId": "rcpt-aaaa-4111-8222-00000000000a",
      "uploadedAt": "2026-02-14T09:30:00Z"
    }
  ],
  "next_cursor": "ratt-cccc-4333-8444-00000000000c"
}

List Mercury recipient invites

List outstanding invites asking recipients for their payment details.

Inputs

Statusstatustext: Only include invites with this status.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Recipient invites. Each has id, recipientId, contactEmail, onboardingUrl and status.

Example output

{
  "items": [
    {
      "contactEmail": "ap@northwind.example",
      "id": "inv-eeee-4555-8666-00000000000e",
      "onboardingUrl": "https://app.mercury.com/invite/inv-eeee",
      "status": "pending"
    }
  ]
}

List Mercury recipients

List saved payment recipients with their default payment method and routing details.

Inputs

Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Recipients. Each has id, name, nickname, emails, status, defaultPaymentMethod and whichever routing-info objects are configured.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "defaultPaymentMethod": "ach",
      "emails": [
        "ap@northwind.example"
      ],
      "id": "rcpt-aaaa-4111-8222-00000000000a",
      "name": "Northwind Design LLC",
      "nickname": "Northwind",
      "status": "active"
    }
  ],
  "next_cursor": "rcpt-aaaa-4111-8222-00000000000a"
}

List Mercury SAFE requests

List SAFE (Simple Agreement for Future Equity) requests raised through Mercury, with investor and valuation details.

Inputs

None.

Outputs

itemslist: SAFE requests, each with id, investor details, amount, valuation type and status.

Example output

{
  "items": [
    {
      "amount": 250000.0,
      "id": "safe-1212-4ccc-8ddd-000000000012",
      "status": "pending",
      "valuationType": "PostMoney"
    }
  ]
}

List Mercury statements

List an account's monthly statements, each with a download URL and opening/closing balances.

Inputs

Accountaccount_idtextRequired: Which account's statements to list.
Fromstartdate: Only include statements ending on or after this date.
Toenddate: Only include statements ending on or before this date.
Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Monthly statements. Each has id, accountNumber, startDate, endDate, startingBalance, endingBalance and downloadUrl.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "accountNumber": "202212783812",
      "downloadUrl": "https://mercury.com/statements/signed-url",
      "endDate": "2026-08-31",
      "endingBalance": 128450.22,
      "id": "stmt-7777-4ddd-8eee-000000000007",
      "startDate": "2026-08-01",
      "startingBalance": 98220.14
    }
  ],
  "next_cursor": "stmt-7777-4ddd-8eee-000000000007"
}

List Mercury transactions

List transactions across every account, with filters for account, card, status, category, free-text search and date range. This is the main way to pull Mercury activity into a workflow.

Inputs

Accountaccount_idtext: Only include transactions on these accounts. Leave empty for all.
Statusstatuslist: Only include transactions with these statuses.One or more of: pending, sent, cancelled, failed, reversed, blocked.
Categorycategory_idtext: Only include transactions in this custom category.
Searchsearchtext: Free-text search over counterparty name and description.
Created fromstartdate: Only include transactions created on or after this date.
Created toenddate: Only include transactions created on or before this date.
Posted fromposted_startdate: Only include transactions that posted on or after this date.
Posted toposted_enddate: Only include transactions that posted on or before this date.
Card IDcard_idlist: Only include transactions made on these card IDs.
Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Mercury transactions. Each has id, accountId, amount (dollars; negative for debits), status, kind, counterpartyName, note, externalMemo, postedAt, createdAt, categoryData, and merchant for card transactions. Note merchant.amount is in the merchant currency's smallest unit, unlike the top-level amount.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "accountId": "8f2c1d4e-1111-4aaa-9bbb-000000000001",
      "amount": -89.99,
      "counterpartyName": "Amazon Web Services",
      "createdAt": "2026-09-10T14:01:58Z",
      "id": "1a2b3c4d-2222-4ccc-8ddd-000000000002",
      "kind": "debitCardTransaction",
      "note": null,
      "postedAt": "2026-09-10T14:02:11Z",
      "status": "sent"
    }
  ],
  "next_cursor": "1a2b3c4d-2222-4ccc-8ddd-000000000002"
}

List Mercury treasury accounts

List treasury accounts with balances and net returns, for tracking yield on idle cash.

Inputs

Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Treasury accounts. Each has id, currentBalance, availableBalance, netReturns, status and createdAt. Amounts are in dollars.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "availableBalance": 750000.0,
      "currentBalance": 750000.0,
      "id": "treas-9999-4fff-8aaa-000000000009",
      "netReturns": 9842.17,
      "status": "active"
    }
  ],
  "next_cursor": "treas-9999-4fff-8aaa-000000000009"
}

List Mercury treasury statements

List statements for a treasury account.

Inputs

Treasury accounttreasury_idtextRequired: The treasury account. Use the id from List Mercury treasury accounts.
Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Treasury statements. Each has id, accountId, description, creationDate and a download URL.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "accountId": "treas-9999-4fff-8aaa-000000000009",
      "creationDate": "2026-09-01",
      "description": "August 2026 treasury statement",
      "id": "tstmt-8888-4eee-8fff-000000000008"
    }
  ],
  "next_cursor": "tstmt-8888-4eee-8fff-000000000008"
}

List Mercury treasury transactions

List the activity on a treasury account.

Inputs

Treasury accounttreasury_idtextRequired: Which treasury account's transactions to list. Use the id from List Mercury treasury accounts.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Treasury transactions. Each has id, amount (dollars), description and settlement dates. next_cursor here is Mercury's own cursor token rather than a row id.
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "amount": 1204.55,
      "description": "Treasury yield - August",
      "id": "ttxn-1010-4aaa-8bbb-000000000010"
    }
  ],
  "next_cursor": ""
}

List Mercury users

List the people on the Mercury account with their roles. Use this to find a userId before issuing a card.

Inputs

Orderordertext: Sort direction for the results.One of: desc (Newest first), asc (Oldest first).
Continue afterstart_aftertext: To get the next page, enter the next_cursor value from the previous run.
Limitlimitnumber: How many results to return, up to 500. Default is 50.From 1 to 500. Default: 50.

Outputs

itemslist: Mercury users. Each has userId, firstName, lastName, email and organizationRole (administrator, bookkeeper, customUser, cardOnlyUser or employee).
next_cursortext: Pass as start_after on the next run to continue after this page. Empty when there are no more results.

Example output

{
  "items": [
    {
      "email": "alex@example.com",
      "firstName": "Alex",
      "lastName": "Rivera",
      "organizationRole": "administrator",
      "userId": "user-5555-4bbb-8ccc-000000000005"
    }
  ],
  "next_cursor": "user-5555-4bbb-8ccc-000000000005"
}

Request Mercury payment approval

Create a payment request that follows your organization's own Mercury approval rules instead of sending money immediately. Prefer this over Send Mercury money in automated workflows: a person still approves the payment in Mercury before any funds move. Needs a read-and-write API token from an allowlisted IP.

Inputs

Accountaccount_idtextRequired: Account the payment would come from.
Recipientrecipient_idtextRequired: Who to pay. Recipients are managed in Mercury or with Create Mercury recipient.
AmountamountnumberRequired: Amount in dollars, for example 250.75.At least 0.01.
Payment methodpayment_methodtextRequired: How to send the money.One of: ach (ACH (free, 1-3 business days)), domesticWire (Domestic wire (same day, fee applies)), check (Paper check (mailed)).
Notenotetext: Internal note, visible only to your team in Mercury.
External memoexternal_memotext: Memo the recipient sees on their statement.
Payment purposepurpose_categorytext: What the payment is for. Mercury uses this for reporting.One of: vendor, contractor, employee, landlord, subsidiary.
Purpose detailspurpose_additional_infotext: Extra context for the payment purpose.

Outputs

accountIdtext
amountnumber: Amount in dollars.
numberOfApproversRequirednumber
paymentMethodtext
recipientIdtext
requestIdtext: Approval request ID. Use as request_id.
requesterMayApprovetrue/false
statustext: pendingApproval until reviewed.

Example output

{
  "amount": 2500.0,
  "counterpartyName": "Northwind Design LLC",
  "requestId": "req-1414-4eee-8fff-000000000014",
  "status": "pending"
}

Send Mercury money

Send an ACH, domestic wire or paper check to a saved recipient. This moves money immediately, subject to Mercury's own approval settings - use Request Mercury payment approval if you want a person in the loop. Needs a read-and-write API token from an allowlisted IP.

Inputs

Accountaccount_idtextRequired: Account the money comes from.
Recipientrecipient_idtextRequired: Who to pay. Recipients are managed in Mercury or with Create Mercury recipient.
AmountamountnumberRequired: Amount in dollars, for example 250.75.At least 0.01.
Payment methodpayment_methodtextRequired: How to send the money.One of: ach (ACH (free, 1-3 business days)), domesticWire (Domestic wire (same day, fee applies)), check (Paper check (mailed)).
Notenotetext: Internal note, visible only to your team in Mercury.
External memoexternal_memotext: Memo the recipient sees on their statement.
Payment purposepurpose_categorytext: What the payment is for. Mercury uses this for reporting.One of: vendor, contractor, employee, landlord, subsidiary.
Purpose detailspurpose_additional_infotext: Extra context for the payment purpose.

Outputs

amountnumber: Amount in dollars (decimal, not cents).
counterpartyNametext: Who was paid.
dashboardLinktext: Link to this payment in the Mercury dashboard.
estimatedDeliveryDatetext: RFC 3339 timestamp of expected settlement.
idtext: Transaction or request ID.
statustext: pending, sent, cancelled, failed, reversed, or blocked.

Example output

{
  "amount": 2500.0,
  "counterpartyName": "Northwind Design LLC",
  "estimatedDeliveryDate": "2026-09-16T00:00:00Z",
  "id": "txn-1515-4fff-8aaa-000000000015",
  "status": "pending"
}

Transfer between Mercury accounts

Move money between two accounts in the same Mercury organization, for example sweeping checking into savings. Needs a read-and-write API token from an allowlisted IP.

Inputs

From accountsource_account_idtextRequired: Account to move money out of.
To accountdestination_account_idtextRequired: Account to move money into.
AmountamountnumberRequired: Amount in dollars, for example 10000.00.At least 0.01.
Notenotetext: Internal note describing the transfer.

Outputs

creditTransactionobject: The transaction putting the money into the destination account (positive amount, in dollars).
debitTransactionobject: The transaction taking the money out of the source account (negative amount, in dollars).

Example output

{
  "creditTransaction": {
    "accountId": "acct-2222-4aaa-8bbb-000000000002",
    "amount": 10000.0,
    "id": "xfer-1717-4aaa-8bbb-000000000017",
    "status": "sent"
  },
  "debitTransaction": {
    "accountId": "acct-1111-4aaa-8bbb-000000000001",
    "amount": -10000.0,
    "id": "xfer-1616-4aaa-8bbb-000000000016",
    "status": "sent"
  }
}

Unfreeze Mercury card

Return a frozen card to active so it accepts charges again. Needs a read-and-write API token.

Inputs

Card IDcard_idtextRequired: The frozen card to reactivate.

Outputs

idtext
statustext: Becomes active.

Example output

{
  "id": "card-4444-4aaa-9bbb-000000000004",
  "status": "active"
}

Update Mercury card

Rename a card or change its spend limit. Leave the nickname empty to keep the current one. Needs a read-and-write API token.

Inputs

Card IDcard_idtextRequired: The card to update.
Nicknamenicknametext: New label for the card.
Spend limitspend_limit_amountnumber: New maximum spend per interval, in dollars.At least 0.01.
Limit resetsspend_limit_intervaltext: How often the spend limit resets. Required when setting a limit.One of: daily (Per day), weekly (Per week), monthly (Per month), yearly (Per year).

Outputs

idtext
lastFourtext
nicknametext
spendLimitobject
statustext

Example output

{
  "id": "card-4444-4aaa-9bbb-000000000004",
  "lastFour": "4242",
  "nickname": "AWS production card",
  "status": "active"
}

Update Mercury category

Rename a custom expense category. Needs a read-and-write API token.

Inputs

Categorycategory_idtextRequired: The category to rename.
NamenametextRequired: New name for the category.

Outputs

idtext
nametext

Example output

{
  "id": "cat-ffff-4666-8777-00000000000f",
  "name": "Cloud & Hosting"
}

Update Mercury customer

Change a customer's name, email or billing address. Fields you leave empty keep their current values. Needs a read-and-write API token.

Inputs

Customer IDcustomer_idtextRequired: The customer to update.
Namenametext: New name.
Emailemailtext: New email address.
Addressaddressobject: New billing address object.
Re-send open invoicesresend_open_invoicestrue/false: Email the customer's unpaid invoices again with the new details. Default is false.Default: false.

Outputs

addressobject: Billing address, if set.
deletedAttext: Set once the customer has been deleted.
emailtext
idtext: Customer ID. Use as customer_id when creating an invoice.
nametext

Example output

{
  "email": "ap@northwind.example",
  "id": "cust-1818-4ccc-8ddd-000000000018",
  "name": "Northwind Design Ltd"
}

Update Mercury invoice

Change an invoice's line items, dates or memos before it is paid. Needs a read-and-write API token.

Inputs

Invoice IDinvoice_idtextRequired: The invoice to update.
Line itemsline_itemslist: Replacement line items. Each has name, quantity, unitPrice and optionally salesTaxRate.
Due datedue_datedate: New due date.
Invoice dateinvoice_datedate: New invoice date.
CC emailscc_emailslist: Replacement list of addresses to copy.
Payer memopayer_memotext: New message for the payer.
Internal noteinternal_notetext: New internal note.
PO numberpo_numbertext: New purchase order number.
Allow ACH debitach_debit_enabledtrue/false: Let the customer pay by ACH debit. Leave empty to keep the current setting.
Allow card paymentcredit_card_enabledtrue/false: Let the customer pay by credit card. Leave empty to keep the current setting.
Show real account numberuse_real_account_numbertrue/false: Show the deposit account's real account number on the invoice. Leave empty to keep the current setting.

Outputs

amountnumber: Line-item total plus taxes, in dollars.
currencyCodetext
customerIdtext
destinationAccountIdtext
dueDatetext: YYYY-MM-DD.
idtext: Invoice ID.
internalNotetext
invoiceDatetext: YYYY-MM-DD.
invoiceNumbertext
lineItemslist
payerMemotext
slugtext: Public slug used to build the pay-page and PDF URLs.
statustext: Unpaid, Paid, Processing or Cancelled.

Example output

{
  "amount": 5200.0,
  "id": "inv-1717-4bbb-8ccc-000000000017",
  "invoiceNumber": "2026-0042",
  "status": "Unpaid"
}

Update Mercury recipient

Change a recipient's name, emails or routing details. Needs a read-and-write API token.

Inputs

Recipientrecipient_idtextRequired: The recipient to update.
Namenametext: New legal or business name.
Emailsemailslist: Replacement list of notification emails.
Contact emailcontact_emailtext: New primary contact email.
Nicknamenicknametext: New internal label.
ACH detailselectronic_routing_infoobject: Bank details for ACH payments, with fields: accountNumber, routingNumber, electronicAccountType (businessChecking, businessSavings, personalChecking or personalSavings), and the account holder's address: an address object (address1, optional address2, city, region, postalCode, country; for example US). All are required.
Wire detailsdomestic_wire_routing_infoobject: Bank details for domestic wires, with fields: accountNumber, routingNumber, and the account holder's address: an address object (address1, optional address2, city, region, postalCode, country; for example US). All are required.
Check detailscheck_infoobject: Mailing details for paper checks: an address object (address1, optional address2, city, region, postalCode, country; for example US), under the key address.

Outputs

checkInfoobject
dateLastPaidtext
defaultPaymentMethodtext: ach, check, domesticWire, internationalWire or realTimePayment.
domesticWireRoutingInfoobject
electronicRoutingInfoobject
emailslist
idtext: Recipient ID. Use as recipient_id when sending money.
nametext
nicknametext
statustext: active or deleted.

Example output

{
  "id": "rcpt-aaaa-4111-8222-00000000000a",
  "name": "Northwind Design LLC",
  "status": "active"
}

Update Mercury transaction

Set or clear a transaction's internal note and custom category. Leave a field empty to clear it.

Inputs

Transaction IDtransaction_idtextRequired: The transaction to update.
Notenotetext: Internal note, visible to your team in Mercury. Leave empty to clear the existing note.
Categorycategory_idtext: Custom expense category to assign. Leave empty to clear it.

Outputs

categoryDataobject: The category now assigned, if any.
idtext
notetext: The note now stored.

Example output

{
  "id": "1a2b3c4d-2222-4ccc-8ddd-000000000002",
  "note": "Reconciled against September AWS invoice"
}

Upload Mercury recipient tax form

Upload a tax form for a recipient. Needs a read-and-write API token.

Inputs

Recipientrecipient_idtextRequired: The recipient the form belongs to.
FilefilelistRequired: The tax form to upload.
File namefile_nametext: Name to store the form under.

Outputs

fileNametext
formTypetext
idtext
recipientIdtext
urltext

Example output

{
  "fileName": "northwind-w9.pdf",
  "formType": "W9",
  "id": "ratt-dddd-4444-8555-00000000000d",
  "recipientId": "rcpt-aaaa-4111-8222-00000000000a"
}

TriggersCopy Anchor Link

New Mercury transactionCopy Anchor Link

Filters

Event fields

ActionsCopy Anchor Link

Attach file to Mercury transactionCopy Anchor Link

Inputs

Outputs

Cancel Mercury cardCopy Anchor Link

Inputs

Outputs

Cancel Mercury invoiceCopy Anchor Link

Inputs

Outputs

Create Mercury categoryCopy Anchor Link

Inputs

Outputs

Create Mercury customerCopy Anchor Link

Inputs

Outputs

Create Mercury invoiceCopy Anchor Link

Inputs

Outputs

Create Mercury recipientCopy Anchor Link

Inputs

Outputs

Create Mercury recipient inviteCopy Anchor Link

Inputs

Outputs

Delete Mercury categoryCopy Anchor Link

Inputs

Outputs

Delete Mercury customerCopy Anchor Link

Inputs

Outputs

Delete Mercury recipientCopy Anchor Link

Inputs

Outputs

Delete Mercury recipient inviteCopy Anchor Link

Inputs

Outputs

Download Mercury invoice PDFCopy Anchor Link

Inputs

Outputs

Download Mercury SAFE documentCopy Anchor Link

Inputs

Outputs

Download Mercury statement PDFCopy Anchor Link

Inputs

Outputs

Freeze Mercury cardCopy Anchor Link

Inputs

Outputs

Get Mercury accountCopy Anchor Link

Inputs

Outputs

Get Mercury cardCopy Anchor Link

Inputs

Outputs

Get Mercury customerCopy Anchor Link

Inputs

Outputs

Get Mercury eventCopy Anchor Link

Inputs

Outputs

Get Mercury invoiceCopy Anchor Link

Inputs

Outputs

Get Mercury invoice attachmentCopy Anchor Link

Inputs

Outputs

Get Mercury organizationCopy Anchor Link

Inputs

Outputs

Get Mercury payment approval requestCopy Anchor Link

Inputs

Outputs

Get Mercury recipientCopy Anchor Link

Inputs

Triggers

New Mercury transaction

Actions

Attach file to Mercury transaction

Cancel Mercury card

Cancel Mercury invoice

Create Mercury category

Create Mercury customer

Create Mercury invoice

Create Mercury recipient

Create Mercury recipient invite

Delete Mercury category

Delete Mercury customer

Delete Mercury recipient

Delete Mercury recipient invite

Download Mercury invoice PDF

Download Mercury SAFE document

Download Mercury statement PDF

Freeze Mercury card

Get Mercury account

Get Mercury card

Get Mercury customer

Get Mercury event

Get Mercury invoice

Get Mercury invoice attachment

Get Mercury organization

Get Mercury payment approval request

Get Mercury recipient

Get Mercury SAFE request

Get Mercury transaction

Get Mercury user

Issue Mercury virtual card

List Mercury accounts

List Mercury cards

List Mercury categories

List Mercury credit accounts

List Mercury customers

List Mercury events

List Mercury invoice attachments

List Mercury invoices

List Mercury payment approval requests

List Mercury recipient attachments

List Mercury recipient invites

List Mercury recipients

List Mercury SAFE requests

List Mercury statements

List Mercury transactions

List Mercury treasury accounts

List Mercury treasury statements

List Mercury treasury transactions

List Mercury users