Mercury Get

Mercury Get

Certified

Get a Mercury account

Retrieve details for a single Mercury bank account by its ID.

yaml
type: io.kestra.plugin.mercury.accounts.Get

Get a Mercury account by ID

yaml
id: get_mercury_account
namespace: company.team

tasks:
  - id: get_account
    type: io.kestra.plugin.mercury.accounts.Get
    apiToken: "{{ secret('MERCURY_API_TOKEN') }}"
    accountId: "d0e567d8-76a7-11e9-a22d-0b33e9de0755"
Properties

Account ID

The unique identifier (UUID) of the Mercury account to retrieve.

Mercury API token

API token for authentication with the Mercury API.

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaulthttps://api.mercury.com/api/v1

Mercury 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.

Account details

The retrieved Mercury bank account.

Definitions
accountNumberstring

Account Number

The account number for the Mercury account.

availableBalancenumber

Available Balance

The available balance of the account in USD (multiple of 0.01).

canReceiveTransactionsboolean

Can Receive Transactions

Whether the account can receive incoming transactions.

canSendRealTimePaymentsboolean

Can Send Real-Time Payments

Whether this account's partner bank supports sending real-time payments (RTP).

createdAtstring
Formatdate-time

Created At

The timestamp when the account was created, in ISO 8601 UTC format (yyyy-MM-ddTHH: mm: ssZ).

currentBalancenumber

Current Balance

The current ledger balance of the account in USD (multiple of 0.01).

dashboardLinkstring

Dashboard Link

The direct URL to view the account in the Mercury dashboard.

idstring

Account ID

The unique identifier (UUID) for the Mercury account.

kindstring

Account Kind

The kind of account, such as checking or savings.

legalBusinessNamestring

Legal Business Name

The legal name of the business associated with the account.

namestring

Account Name

The name of the account.

nicknamestring

Account Nickname

An optional nickname for the account.

routingNumberstring

Routing Number

The routing number for the Mercury account.

statusstring

Account Status

The status of the account. Possible values: active, deleted, pending, archived.

typestring

Account Type

The type of account. Possible values: mercury, external, recipient.

More Plugins in this Category

Ashby
Ashby

Ashby plugin for Kestra

Data

1 tasks

1 blueprints

SAP HANA
SAP HANA

Tasks that query SAP HANA using the official SAP HANA JDBC driver (ngdbc.jar).

Data

3 tasks

3 blueprints