Sign in

v45

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

Add a new recipient

Create a new recipient for making payments

post/recipients

Request body

contactEmailstring
emailsEmail[] required
namestring required
nicknamestring

Response

contactEmailstring
dateLastPaidstring yyyy-mm-ddThh:MM:ssZ
defaultPaymentMethod'ach' | 'check' | 'domesticWire' | 'internationalWire' | 'realTimePayment' required
emailsEmail[] required
idstring uuid required

ID for a Mercury account.

inviteIdstring
isBusinessboolean nullable
namestring required
nicknamestring nullable
status'active' | 'deleted' required

Example response

{
  "attachments": [
    {
      "uploadedAt": "2016-07-22T00:00:00Z"
    }
  ],
  "dateLastPaid": "2016-07-22T00:00:00Z"
}