Mercury: Add a new recipient
Mercury recipients.createRecipient: arguments, response, policy and SDK examples.
← Recipients operations · Get started
Operation mercury.createrecipient
Provider route: POST /recipients. 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["recipients"]["createRecipient"]>[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.recipients.createRecipient(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.recipients.create_recipient(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 Add a new recipient — request body — body |
Referenced models: Add a new recipient — 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 Add a new recipient — response body |
Referenced models: Add a new recipient — response body
Schemas
Section titled “Schemas”24 more schemas are linked from the tables above, on the schema pages.
Add a new recipient — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region |
address (anyOf 2) | null | Alternative | |
attachments | array | Required within parent | |
attachments[] | Model | Each item | Expand Add a new recipient — response body — attachments item |
checkInfo | JSON | Optional | |
checkInfo (anyOf 1) | JSON | Alternative | |
checkInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — check Info address address |
checkInfo (anyOf 2) | null | Alternative | |
contactEmail | JSON | Optional | |
contactEmail (anyOf 1) | JSON | Alternative | |
contactEmail (anyOf 1) (allOf 1) | string | All variants apply | |
contactEmail (anyOf 2) | null | Alternative | |
dateLastPaid | JSON | Optional | |
dateLastPaid (anyOf 1) | JSON | Alternative | |
dateLastPaid (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
dateLastPaid (anyOf 2) | null | Alternative | |
defaultAddress | JSON | Optional | |
defaultAddress (anyOf 1) | JSON | Alternative | |
defaultAddress (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region |
defaultAddress (anyOf 2) | null | Alternative | |
defaultPaymentMethod | JSON | Required within parent | |
defaultPaymentMethod (allOf 1) | string | All variants apply | Known values: ach, check, domesticWire, internationalWire, realTimePayment |
domesticWireRoutingInfo | JSON | Optional | |
domesticWireRoutingInfo (anyOf 1) | JSON | Alternative | |
domesticWireRoutingInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number |
domesticWireRoutingInfo (anyOf 2) | null | Alternative | |
electronicRoutingInfo | JSON | Optional | |
electronicRoutingInfo (anyOf 1) | JSON | Alternative | |
electronicRoutingInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — electronic Routing Info account Number, address, bank Name, electronic Account Type, routing Number account Number, address, bank Name, electronic Account Type, routing Number |
electronicRoutingInfo (anyOf 2) | null | Alternative | |
emails | array | Required within parent | |
emails[] | string | Each item | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
internationalWireRoutingInfo | JSON | Optional | |
internationalWireRoutingInfo (anyOf 1) | JSON | Alternative | |
internationalWireRoutingInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code |
internationalWireRoutingInfo (anyOf 2) | null | Alternative | |
inviteId | JSON | Optional | |
inviteId (anyOf 1) | JSON | Alternative | |
inviteId (anyOf 1) (allOf 1) | string | All variants apply | |
inviteId (anyOf 2) | null | Alternative | |
isBusiness | JSON | Optional | |
isBusiness (anyOf 1) | boolean | Alternative | |
isBusiness (anyOf 2) | null | Alternative | |
name | string | Required within parent | |
nickname | JSON | Optional | |
nickname (anyOf 1) | string | Alternative | |
nickname (anyOf 2) | null | Alternative | |
realTimePaymentRoutingInfo | JSON | Optional | |
realTimePaymentRoutingInfo (anyOf 1) | JSON | Alternative | |
realTimePaymentRoutingInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number |
realTimePaymentRoutingInfo (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: active, deleted |
Referenced models: Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region, Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number, Add a new recipient — response body — electronic Routing Info account Number, address, bank Name, electronic Account Type, routing Number account Number, address, bank Name, electronic Account Type, routing Number, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code, Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region, Add a new recipient — response body — check Info address address, Add a new recipient — response body — attachments item
Add a new recipient — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
address | JSON | Optional | Deprecated. Use checkInfo instead. |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body address address1, address2, city, postal Code, state |
checkInfo | JSON | Optional | Information needed to send a physical check. |
checkInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body check Info address |
contactEmail | JSON | Optional | Contact email address of the recipient |
contactEmail (allOf 1) | string | All variants apply | |
domesticWireRoutingInfo | JSON | Optional | Information needed to send a domestic wire. |
domesticWireRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number |
electronicRoutingInfo | JSON | Optional | Information needed to send an ACH. |
electronicRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number |
emails | array | Required within parent | |
emails[] | string | Each item | |
name | string | Required within parent | Maximum length: 299 Minimum length: 1 |
nickname | string | Optional | Maximum length: 299 |
realTimePaymentRoutingInfo | JSON | Optional | Information needed to send a real-time payment. |
realTimePaymentRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body real Time Payment Routing Info Routing information for real-time payments |
Referenced models: Add a new recipient — request body — body address address1, address2, city, postal Code, state, Add a new recipient — request body — body check Info address, Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number, Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number, Add a new recipient — request body — body real Time Payment Routing Info Routing information for real-time payments
Add a new recipient — response body — check Info address address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Required within parent | |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region |
Referenced models: Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.createrecipient. Catalog operation: mercury:createRecipient. 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.