Sign in
Accounts

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.

post/account/{accountId}/transactions

Path parameters

accountIdstring uuid required

ID for a Mercury account.

Request body

amountnumber double required

A positive dollar amount with at least 1 cent.

externalMemostring

Optional external memo

idempotencyKeystring required

Unique string identifying the transaction

notestring

Optional note

paymentMethod'ach' | 'check' | 'domesticWire' required
recipientIdstring uuid required

ID for a Mercury account.

Response

accountIdstring uuid required

The external-facing account identifier for the Mercury account that owns this transaction

amountnumber required
bankDescriptionstring nullable
checkNumberstring nullable

Present for check deposits and mailed checks; Nothing otherwise.

compliantWithReceiptPolicyboolean required
counterpartyIdstring uuid required

ID for a Mercury account.

counterpartyNamestring required
counterpartyNicknamestring nullable
createdAtstring yyyy-mm-ddThh:MM:ssZ required
creditAccountPeriodIdstring uuid

ID for the credit statement period

dashboardLinkstring required
estimatedDeliveryDatestring yyyy-mm-ddThh:MM:ssZ required
externalMemostring nullable
failedAtstring yyyy-mm-ddThh:MM:ssZ
feeIdstring uuid

ID for this transaction

generalLedgerCodeNamestring nullable

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

hasGeneratedReceiptboolean required
idstring uuid required

ID for this transaction

kind'externalTransfer' | 'internalTransfer' | 'outgoingPayment' | 'creditCardCredit' | 'creditCardTransaction' | 'debitCardCredit' | 'debitCardTransaction' | 'cardInternationalTransactionFee' | 'cardInternationalTransactionFeeRebate' | 'cardInternationalTransactionFeeReversal' | 'cardInternationalTransactionFeeRebateReversal' | 'incomingDomesticWire' | 'checkDeposit' | 'incomingInternationalWire' | 'treasuryTransfer' | 'currencyCloudReturn' | 'wireFee' | 'personalBankingSubscriptionFee' | 'billingEngineSubscriptionFee' | 'expenseReimbursement' | 'exogenousWireDrawdown' | 'interestPayment' | 'other' required
mercuryCategory'Other' | 'Advertising' | 'Airlines' | 'AlcoholAndBars' | 'BooksAndNewspaper' | 'CarRental' | 'Charity' | 'Clothing' | 'Conferences' | 'Education' | 'Electronics' | 'Entertainment' | 'FacilitiesExpenses' | 'Fees' | 'FoodDelivery' | 'FuelAndGas' | 'Gambling' | 'GovernmentServices' | 'Grocery' | 'GroundTransportation' | 'Insurance' | 'InternetAndTelephone' | 'Legal' | 'Lodging' | 'Medical' | 'Memberships' | 'OfficeSupplies' | 'OtherTravel' | 'Parking' | 'Political' | 'ProfessionalServices' | 'Restaurants' | 'Retail' | 'RideshareAndTaxis' | 'Shipping' | 'Software' | 'Taxes' | 'Utilities' | 'VehicleExpenses'
notestring nullable
postedAtstring yyyy-mm-ddThh:MM:ssZ
reasonForFailurestring nullable
requestIdstring nullable
status'pending' | 'sent' | 'cancelled' | 'failed' | 'reversed' | 'blocked' required
trackingNumberstring nullable

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

Example response

{
  "createdAt": "2016-07-22T00:00:00Z",
  "estimatedDeliveryDate": "2016-07-22T00:00:00Z",
  "failedAt": "2016-07-22T00:00:00Z",
  "postedAt": "2016-07-22T00:00:00Z"
}

Changes

Changed in 5 of the 45 revisions of this API.13318

  • 0bdf4a496e031See the full diff
    • ●

      added the new interestPayment enum value to the //// response property for the response status

      response-property-enum-value-added

  • efb022d1e11e1313See the full diff
    • ▲

      removed the enum value AngelInvestment of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value Contractor of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value Employee of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value Expenses of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value FamilyMemberOrFriend of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value ForGoodsOrServices of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value Landlord of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value Other of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value SavingsOrInvestments of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value Subsidiary of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value TransferToMyExternalAccount of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value Travel of the request property //////////

      request-property-enum-value-removed

    • ▲

      removed the enum value Vendor of the request property //////////

      request-property-enum-value-removed

    • ○

      added the new angelInvestment enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new contractor enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new employee enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new expenses enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new familyMemberOrFriend enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new forGoodsOrServices enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new landlord enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new other enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new savingsOrInvestments enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new subsidiary enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new transferToMyExternalAccount enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new travel enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new vendor enum value to the request property //////////

      request-property-enum-value-added

  • 621b18bfbb912See the full diff
    • ●

      added the new MerchantRefundToOriginalCharge enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new OriginalChargeToMerchantRefund enum value to the ////// response property for the response status

      response-property-enum-value-added

  • 2108b9d605242See the full diff
    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

  • 3e266f593eb13See the full diff
    • ○

      added the required property ///// to the response with the status

      response-required-property-added

    • ○

      added the required property ///// to the response with the status

      response-required-property-added

    • ○

      added the required property ///// to the response with the status

      response-required-property-added