Sign in

v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-2684278289.5 KB
Accounts

Request to send money

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

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

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

ID for a Mercury account.

Response

accountIdstring uuid required

ID for a Mercury account.

amountnumber double required

A positive dollar amount with at least 1 cent.

createdAtstring yyyy-mm-ddThh:MM:ssZ required

Time at which the payment request was created.

memostring nullable
numberOfApproversRequiredinteger nullable

Total number of approvals required for this payment to be sent. May be null for older requests where the requirement is not available.

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

ID for a Mercury account.

requestIdstring required
requestedByUserIdstring uuid required

The user who created the payment request.

scheduledSendDatestring date nullable

Date on which the payment is scheduled to be sent once fully approved. Null when the payment will be sent as soon as approvals are complete.

status'pendingApproval' | 'approved' | 'rejected' | 'cancelled' required

Example response

{
  "createdAt": "2016-07-22T00:00:00Z",
  "reviews": [
    {
      "reviewedAt": "2016-07-22T00:00:00Z"
    }
  ],
  "scheduledSendDate": "2016-07-22"
}