Accounts

Request to send money

Changed on

Create a "request to send money" that will require approval based on your organization's approval policies.

post/account/{accountId}/request-send-money

Request

  • Base URL
    https://api.mercury.com/api/v1
  • URL
    https://api.mercury.com/api/v1/account/{accountId}/request-send-money
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

accountIdstring uuid required

The Mercury account where invoice payments will be deposited. Use the /api/v1/accounts endpoint to list your accounts and find the corresponding id. Only checking and savings accounts are supported.

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' | 'internationalWire' required
recipientIdstring uuid required

The Mercury account where invoice payments will be deposited. Use the /api/v1/accounts endpoint to list your accounts and find the corresponding id. Only checking and savings accounts are supported.

Changes

  • ab652aa5aa8eRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      media type application/json was changed to application/json;charset=utf-8 for the response status

  • efb022d1e11eRevision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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