Mercury: Recipient invites schemas
3 Mercury schemas with complete fields and constraints.
← Recipient invites operations · All schemas
Create a recipient invite — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for creating a recipient invite. Additional keys: not allowed |
contactEmail | JSON | Required within parent | |
contactEmail (allOf 1) | string | All variants apply | |
contactEmail (allOf 2) | JSON | All variants apply | Contact email the invite is sent to. When 'recipientId' is present, updates the recipient's contact email to this value. |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | 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. Maximum length: 299 Minimum length: 1 |
name (anyOf 2) | null | Alternative | |
notes | JSON | Optional | |
notes (anyOf 1) | string | Alternative | Optional notes shown to the recipient. Maximum length: 5000 Minimum length: 1 |
notes (anyOf 2) | null | Alternative | |
organizationNameOnRequest | JSON | Optional | |
organizationNameOnRequest (anyOf 1) | string | Alternative | Optional organization name to display on the request. Maximum length: 299 Minimum length: 1 |
organizationNameOnRequest (anyOf 2) | null | Alternative | |
paymentMethods | array | Required within parent | Payment methods the recipient may submit details for. Minimum items: 1 |
paymentMethods[] | string | Each item | One of: ach, check, domesticWire, internationalWire, realTimePayment |
recipientId | JSON | Optional | |
recipientId (anyOf 1) | JSON | Alternative | |
recipientId (anyOf 1) (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
recipientId (anyOf 1) (allOf 2) | JSON | All variants apply | The recipient to send the invite to. |
recipientId (anyOf 2) | null | Alternative | |
requireTaxDocument | boolean | Required within parent | Whether the recipient must upload a tax document. |
sendEmail | boolean | Required within parent | When true, sends an Email to the invitee. When false, does not send an email to the invitee. |
Create a recipient invite — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contactEmail | JSON | Required within parent | |
contactEmail (allOf 1) | string | All variants apply | |
contactEmail (allOf 2) | JSON | All variants apply | Recipient contact email the invite was created for. |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
createdAt (allOf 2) | JSON | All variants apply | When the invite was created. |
expiresAt | JSON | Optional | |
expiresAt (anyOf 1) | JSON | Alternative | |
expiresAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
expiresAt (anyOf 1) (allOf 2) | JSON | All variants apply | When the invite expires, if it has an expiry. |
expiresAt (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the invite |
id (allOf 2) | JSON | All variants apply | The invite's id, also embedded in 'onboardingUrl'. |
name | string | Required within parent | Recipient name the invite was created for. |
notes | JSON | Optional | |
notes (anyOf 1) | string | Alternative | Notes shown to the recipient, if any. |
notes (anyOf 2) | null | Alternative | |
onboardingUrl | string | Required within parent | URL where the recipient submits their payment details. |
paymentMethods | array | Required within parent | Payment methods the recipient may submit details for. Minimum items: 1 |
paymentMethods[] | string | Each item | Known values: ach, check, domesticWire, internationalWire, realTimePayment |
recipientId | JSON | Optional | |
recipientId (anyOf 1) | JSON | Alternative | |
recipientId (anyOf 1) (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
recipientId (anyOf 1) (allOf 2) | JSON | All variants apply | The existing recipient this invite is for, if any. |
recipientId (anyOf 2) | null | Alternative | |
requireTaxDocument | boolean | Required within parent | Whether the recipient must upload a tax document. |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: created, completed, expired, declined |
status (allOf 2) | JSON | All variants apply | Status of the invite. |
List recipient invites — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | API response for listing recipient invites with pagination. |
invites | array | Required within parent | List of invites in the current page. |
invites[] | Model | Each item | Expand Create a recipient invite — response body |
page | object | Required within parent | Pagination cursors (inviteId) for navigating to next/previous pages. |
page.nextPage | string | Optional | ID for the invite |
page.previousPage | string | Optional | ID for the invite |
Referenced models: Create a recipient invite — response body