Mercury List
CertifiedList Mercury accounts
Mercury List
List Mercury accounts
Retrieve all Mercury bank accounts with automatic cursor-based pagination.
type: io.kestra.plugin.mercury.accounts.ListExamples
List all Mercury accounts into memory
id: list_mercury_accounts
namespace: company.team
tasks:
- id: list_accounts
type: io.kestra.plugin.mercury.accounts.List
apiToken: "{{ secret('MERCURY_API_TOKEN') }}"
fetchType: FETCH
Stream all Mercury accounts to internal storage
id: store_mercury_accounts
namespace: company.team
tasks:
- id: store_accounts
type: io.kestra.plugin.mercury.accounts.List
apiToken: "{{ secret('MERCURY_API_TOKEN') }}"
fetchType: STORE
Properties
apiToken *string
Mercury API token
API token for authentication with the Mercury API.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl string
https://api.mercury.com/api/v1Mercury API base URL
Base URL for the Mercury API. Override for the Mercury sandbox (https://api-sandbox.mercury.com/api/v1). Must use HTTPS, except for loopback hosts (localhost, 127.0.0.1, ::1) during local testing.
fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch mode
Controls how results are returned: FETCH to return all rows in memory, FETCH_ONE for the first row, STORE to stream records as ION into internal storage, or NONE to skip collecting outputs.
limit integerstring
1000Results per page
Maximum number of accounts to return per page. Minimum 1, maximum 1000. Default is 1000.
order string
ASCASCDESCSort order
Sort order for accounts. Allowed values: ASC or DESC. Default is ASC.
pageCap integerstring
100Maximum pages to retrieve
Safety cap on the number of pages fetched during pagination. Minimum 1. Default is 100.
Outputs
row
The first account fetched
The first account retrieved. Only populated when fetchType is FETCH_ONE.
io.kestra.plugin.mercury.model.Account
Account Number
The account number for the Mercury account.
Available Balance
The available balance of the account in USD (multiple of 0.01).
Can Receive Transactions
Whether the account can receive incoming transactions.
Can Send Real-Time Payments
Whether this account's partner bank supports sending real-time payments (RTP).
date-timeCreated At
The timestamp when the account was created, in ISO 8601 UTC format (yyyy-MM-ddTHH: mm: ssZ).
Current Balance
The current ledger balance of the account in USD (multiple of 0.01).
Dashboard Link
The direct URL to view the account in the Mercury dashboard.
Account ID
The unique identifier (UUID) for the Mercury account.
Account Kind
The kind of account, such as checking or savings.
Legal Business Name
The legal name of the business associated with the account.
Account Name
The name of the account.
Account Nickname
An optional nickname for the account.
Routing Number
The routing number for the Mercury account.
Account Status
The status of the account. Possible values: active, deleted, pending, archived.
Account Type
The type of account. Possible values: mercury, external, recipient.
rows array
The accounts fetched
List of retrieved accounts. Only populated when fetchType is FETCH.
io.kestra.plugin.mercury.model.Account
Account Number
The account number for the Mercury account.
Available Balance
The available balance of the account in USD (multiple of 0.01).
Can Receive Transactions
Whether the account can receive incoming transactions.
Can Send Real-Time Payments
Whether this account's partner bank supports sending real-time payments (RTP).
date-timeCreated At
The timestamp when the account was created, in ISO 8601 UTC format (yyyy-MM-ddTHH: mm: ssZ).
Current Balance
The current ledger balance of the account in USD (multiple of 0.01).
Dashboard Link
The direct URL to view the account in the Mercury dashboard.
Account ID
The unique identifier (UUID) for the Mercury account.
Account Kind
The kind of account, such as checking or savings.
Legal Business Name
The legal name of the business associated with the account.
Account Name
The name of the account.
Account Nickname
An optional nickname for the account.
Routing Number
The routing number for the Mercury account.
Account Status
The status of the account. Possible values: active, deleted, pending, archived.
Account Type
The type of account. Possible values: mercury, external, recipient.
size integer
The total number of accounts returned
For FETCH this matches the size of rows, for FETCH_ONE 0 or 1, for STORE the count of stored records, and 0 for NONE.
uri string
uriURI of stored results
The URI of the file containing ION-formatted records in internal storage. Only populated when fetchType is STORE.
