Skip to content

Mercury: Get all recipients

Mercury recipients.getRecipients: arguments, response, policy and SDK examples.

← Recipients operations · Get started

Operation mercury.getrecipients

Provider route: GET /recipients. 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["recipients"]["getRecipients"]>[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.getRecipients(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.recipients.get_recipients(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.start_afterstringOptionalThe ID of the recipient to start the page after (exclusive). When provided, results will begin with the recipient immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
Format: uuid
query.end_beforestringOptionalThe ID of the recipient to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
Format: uuid
query.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’
Default: asc
One of: asc, desc

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get all recipients — response body

Referenced models: Get all recipients — response body

17 more schemas are linked from the tables above, on the schema pages.

Get all recipients — response body
FieldTypePresenceDescription and constraints
$objectRoot
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the recipient
Format: uuid
page.previousPagestringOptionalID for the recipient
Format: uuid
recipientsarrayRequired within parentList of recipients in the current page
recipients[]ModelEach itemExpand Add a new recipient — response body
totalJSONRequired within parent
total (allOf 1)ModelAll variants applyExpand Get all recipients — response body — total value
total (allOf 2)JSONAll variants applyTotal number of recipients in the current page

Referenced models: Add a new recipient — response body, Get all recipients — response body — total value

Add a new recipient — response body
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
attachmentsarrayRequired within parent
attachments[]ModelEach itemExpand Add a new recipient — response body — attachments item
checkInfoJSONOptional
checkInfo (anyOf 1)JSONAlternative
checkInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand Add a new recipient — response body — check Info address address
checkInfo (anyOf 2)nullAlternative
contactEmailJSONOptional
contactEmail (anyOf 1)JSONAlternative
contactEmail (anyOf 1) (allOf 1)stringAll variants apply
contactEmail (anyOf 2)nullAlternative
dateLastPaidJSONOptional
dateLastPaid (anyOf 1)JSONAlternative
dateLastPaid (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
dateLastPaid (anyOf 2)nullAlternative
defaultAddressJSONOptional
defaultAddress (anyOf 1)JSONAlternative
defaultAddress (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
defaultPaymentMethodJSONRequired within parent
defaultPaymentMethod (allOf 1)stringAll variants applyKnown values: ach, check, domesticWire, internationalWire, realTimePayment
domesticWireRoutingInfoJSONOptional
domesticWireRoutingInfo (anyOf 1)JSONAlternative
domesticWireRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
electronicRoutingInfoJSONOptional
electronicRoutingInfo (anyOf 1)JSONAlternative
electronicRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
emailsarrayRequired within parent
emails[]stringEach item
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
internationalWireRoutingInfoJSONOptional
internationalWireRoutingInfo (anyOf 1)JSONAlternative
internationalWireRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
inviteIdJSONOptional
inviteId (anyOf 1)JSONAlternative
inviteId (anyOf 1) (allOf 1)stringAll variants apply
inviteId (anyOf 2)nullAlternative
isBusinessJSONOptional
isBusiness (anyOf 1)booleanAlternative
isBusiness (anyOf 2)nullAlternative
namestringRequired within parent
nicknameJSONOptional
nickname (anyOf 1)stringAlternative
nickname (anyOf 2)nullAlternative
realTimePaymentRoutingInfoJSONOptional
realTimePaymentRoutingInfo (anyOf 1)JSONAlternative
realTimePaymentRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown 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

Get all recipients — response body — total value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)integerAlternativeFormat: int32
Maximum: 1000
Minimum: 0
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region
FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parent
address2JSONOptional
address2 (anyOf 1)stringAlternative
address2 (anyOf 2)nullAlternative
citystringRequired within parent
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
postalCodestringRequired within parent
regionJSONRequired within parent
region (allOf 1)stringAll variants apply
Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region
FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parentMaximum length: 299
Minimum length: 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
address2 (anyOf 2)nullAlternative
citystringRequired within parentMaximum length: 299
Minimum length: 1
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
namestringRequired within parent
postalCodestringRequired within parentMaximum length: 299
Minimum length: 1
regionJSONRequired within parent
region (allOf 1)stringAll variants apply

SDK function policy ID: mercury.getrecipients. Catalog operation: mercury:getRecipients. 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.