Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Create a recipient invite — request body — body

Referenced models: Create a recipient invite — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a recipient invite — response body

Referenced models: Create a recipient invite — response body

Create a recipient invite — response body
FieldTypePresenceDescription and constraints
$objectRoot
contactEmailJSONRequired within parent
contactEmail (allOf 1)stringAll variants apply
contactEmail (allOf 2)JSONAll variants applyRecipient contact email the invite was created for.
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
createdAt (allOf 2)JSONAll variants applyWhen the invite was created.
expiresAtJSONOptional
expiresAt (anyOf 1)JSONAlternative
expiresAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
expiresAt (anyOf 1) (allOf 2)JSONAll variants applyWhen the invite expires, if it has an expiry.
expiresAt (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the invite
id (allOf 2)JSONAll variants applyThe invite's id, also embedded in 'onboardingUrl'.
namestringRequired within parentRecipient name the invite was created for.
notesJSONOptional
notes (anyOf 1)stringAlternativeNotes shown to the recipient, if any.
notes (anyOf 2)nullAlternative
onboardingUrlstringRequired within parentURL where the recipient submits their payment details.
paymentMethodsarrayRequired within parentPayment methods the recipient may submit details for.
Minimum items: 1
paymentMethods[]stringEach itemKnown values: ach, check, domesticWire, internationalWire, realTimePayment
recipientIdJSONOptional
recipientId (anyOf 1)JSONAlternative
recipientId (anyOf 1) (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
recipientId (anyOf 1) (allOf 2)JSONAll variants applyThe existing recipient this invite is for, if any.
recipientId (anyOf 2)nullAlternative
requireTaxDocumentbooleanRequired within parentWhether the recipient must upload a tax document.
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: created, completed, expired, declined
status (allOf 2)JSONAll variants applyStatus of the invite.
Create a recipient invite — request body — body
FieldTypePresenceDescription and constraints
$objectRootRequest body for creating a recipient invite.
Additional keys: not allowed
contactEmailJSONRequired within parent
contactEmail (allOf 1)stringAll variants apply
contactEmail (allOf 2)JSONAll variants applyContact email the invite is sent to. When 'recipientId' is present, updates the recipient's contact email to this value.
nameJSONOptional
name (anyOf 1)stringAlternativeName 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)nullAlternative
notesJSONOptional
notes (anyOf 1)stringAlternativeOptional notes shown to the recipient.
Maximum length: 5000
Minimum length: 1
notes (anyOf 2)nullAlternative
organizationNameOnRequestJSONOptional
organizationNameOnRequest (anyOf 1)stringAlternativeOptional organization name to display on the request.
Maximum length: 299
Minimum length: 1
organizationNameOnRequest (anyOf 2)nullAlternative
paymentMethodsarrayRequired within parentPayment methods the recipient may submit details for.
Minimum items: 1
paymentMethods[]stringEach itemOne of: ach, check, domesticWire, internationalWire, realTimePayment
recipientIdJSONOptional
recipientId (anyOf 1)JSONAlternative
recipientId (anyOf 1) (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
recipientId (anyOf 1) (allOf 2)JSONAll variants applyThe recipient to send the invite to.
recipientId (anyOf 2)nullAlternative
requireTaxDocumentbooleanRequired within parentWhether the recipient must upload a tax document.
sendEmailbooleanRequired within parentWhen true, sends an Email to the invitee. When false, does not send an email to the invitee.

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.