Skip to navigation
API ReferencePayments

Send money to a recipient

Send money from an account to a recipient. Creates a transaction that will be processed immediately or may require approval.

Authentication

AuthorizationBearer

Bearer token authentication for Mercury API.

Use your API token in the Authorization header: Authorization: Bearer TOKEN

Example: Authorization: Bearer secret-token:mercury_production_wma_24SCp4G81X3yHL4Wq8FgzuaP9ye3VKf2mgTDctXyRg5HY_yrucrem

Your Mercury API token should include the ‘secret-token:’ prefix. Tokens can be generated from your Mercury dashboard settings.

Path parameters

accountIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
amountdoubleRequired>=0.01
Amount of USD you want to send, must be a positive number.
idempotencyKeystringRequired
Unique string identifying the transaction
paymentMethodenumRequired
If domesticWire is used, then the purpose field is required.
Allowed values:
recipientIdstringRequiredformat: "uuid"

Recipient ID from the /recipients endpoint.

externalMemostringOptional
Optional external memo
notestringOptional
Optional note
purposeobjectOptional
Purpose of payment with category and optional additional info. Required when paymentMethod is 'domesticWire'.

Response

accountIdstringformat: "uuid"
amountdouble
Transaction amount in USD. Negative for debits, positive for credits.
attachmentslist of objects

List of file attachments (receipts, check images, etc.).

compliantWithReceiptPolicyboolean
Whether the transaction has all required receipts attached per your policy.
counterpartyIdstringformat: "uuid"
Unique identifier of the counterparty in this transaction.
counterpartyNamestring
Display name of the counterparty.
createdAtstringformat: "yyyy-mm-ddThh:MM:ssZ"
Timestamp when the transaction was created.
estimatedDeliveryDatestringformat: "yyyy-mm-ddThh:MM:ssZ"
Estimated delivery date for the payment.
glAllocationslist of objects

GL code allocations assigned to this transaction via a connected accounting software integration (e.g. QuickBooks, Xero, NetSuite). Each allocation has a GL code name and the amount allocated to it; amounts sum to the transaction total when the transaction is fully categorized. Empty if no GL codes have been assigned. Distinct from Mercury custom categories (see transactionCategoryData).

hasGeneratedReceiptboolean

Whether Mercury has auto-generated a receipt for this transaction.

idstringformat: "uuid"
Unique identifier for the transaction.
kindenum

The type of transaction (e.g., externalTransfer, internalTransfer, cardPayment).

relatedTransactionslist of objects

List of related transactions (e.g., fees, reversals).

statusenum

Current status of the transaction (pending, sent, cancelled, failed).

bankDescriptionstring or nullOptional

Bank-provided description of the transaction.

categoryDataobject or nullOptional
Custom category information assigned to this transaction.
checkNumberstring or nullOptional

Present for check deposits and mailed checks; Nothing otherwise.

counterpartyNicknamestring or nullOptional

User-defined nickname for the counterparty.

creditAccountPeriodIdstring or nullOptionalformat: "uuid"
Credit account statement period this transaction belongs to.
currencyExchangeInfoobject or nullOptional
Currency exchange details for international transactions.
detailsobject or nullOptional

Payment method routing details (ACH, wire, check info).

externalMemostring or nullOptional
Memo visible to the counterparty.
failedAtstring or nullOptionalformat: "yyyy-mm-ddThh:MM:ssZ"
Timestamp when the transaction failed, if applicable.
feeIdstring or nullOptionalformat: "uuid"
ID of the associated fee transaction, if any.
generalLedgerCodeNamestring or nullOptional

Deprecated: use transactionGlAllocations instead. This field does not reflect GL codes assigned via Mercury auto-categorization rules. Preserved for backwards compatibility.

merchantobject or nullOptional
mercuryCategoryenum or nullOptional

Mercury-assigned spending category.

notestring or nullOptional

Internal note on the transaction (not visible to counterparty).

postedAtstring or nullOptionalformat: "yyyy-mm-ddThh:MM:ssZ"
Timestamp when the transaction was posted to the account.
reasonForFailurestring or nullOptional

Human-readable reason for transaction failure, if applicable.

requestIdstring or nullOptional
ID of the associated send money approval request, if applicable.
trackingNumberstring or nullOptional

Present for transactions that have tracking numbers (e.g., RTP, ACH, wires); Nothing otherwise.

Errors

400
Bad Request Error
404
Not Found Error