Create a recipient invite

post

https://api.mercury.com/api/v1/recipients/invites

Create an invite for a recipient to submit their payment details. Supply a recipientId to invite an existing recipient; omit it to invite someone new, in which case the recipient is created when the invitee completes onboarding.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for creating a recipient invite.

contactEmail

string

required

Contact email the invite is sent to. When 'recipientId' is present, updates the recipient's contact email to this value.

name

string | null

Name the invite is created for. This field is required when 'recipientId' is absent. When 'recipientId' is present, this field is optional and updates the recipient's name to this value.

notes

string | null

Optional notes shown to the recipient.

organizationNameOnRequest

string | null

Optional organization name to display on the request.

paymentMethods

array of objects

required

length ≥ 1

Payment methods the recipient may submit details for.

paymentMethods*

Allowed:

recipientId

uuid | null

The recipient to send the invite to.

requireTaxDocument

boolean

required

Whether the recipient must upload a tax document.

sendEmail

boolean

required

When true, sends an Email to the invitee. When false, does not send an email to the invitee.

Responses

400

Invalid body

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201