Sign in
Recipients

Edit information about a specific recipient

Update an existing recipient's information

post/recipient/{recipientId}

Path parameters

recipientIdstring uuid required

ID for a Mercury account.

Request body

contactEmailstring
emailsEmail[]
namestring
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"
}

Changes

Changed in 1 of the 45 revisions of this API.1

  • 57d0bcefe5d11See the full diff
    • ○

      added the optional property inviteId to the response with the 200 status

      response-optional-property-added