Mercury: Create a recipient invite
Mercury recipientInvites.createRecipientInvite: arguments, response, policy and SDK examples.
← Recipient invites operations · Get started
Operation mercury.createrecipientinvite
Provider route: POST /recipients/invites. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["recipientInvites"]["createRecipientInvite"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.recipientInvites.createRecipientInvite(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.recipient_invites.create_recipient_invite(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create a recipient invite — request body — body |
Referenced models: Create a recipient invite — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a recipient invite — response body |
Referenced models: Create a recipient invite — response body
Schemas
Section titled “Schemas”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. |
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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.createrecipientinvite. Catalog operation: mercury:createRecipientInvite. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.