Skip to main content
GET
Get an account

Authorizations

api-key
string
header
required

Headers

Melio-Entity-Id
string
required

Entity the request operates on — an entity id (ent_<uuid>) or me (the partner's sole entity).

Path Parameters

accountId
string
required

Response

Account.

id
string

Opaque account id (acct_)

externalId
string

Your own unique identifier for the resource. Unique per partner per resource type (reusing one returns 409 DUPLICATE_EXTERNAL_ID). Distinct from the Idempotency-Key header, which dedupes the request rather than identifying the resource.

Maximum string length: 255
Pattern: ^[A-Za-z0-9_-]+$
metadata
object

Free-form string key/value pairs stored and returned verbatim, never interpreted by Melio. Up to 50 keys; each key 1 to 40 chars and may not contain square brackets ([ ], reserved for the metadata[key] filter); value ≤100 chars. Filterable via metadata[key].

ownershipType
enum<string>
Available options:
internal,
external
type
enum<string>

Plaid-backed internal accounts are returned as ach.

Available options:
ach,
check,
card,
domestic-wire,
virtual-card
nickname
string

Present for internal accounts.

counterPartyName
string

Present for external accounts.

counterPartyEmail
string

Counterparty (payee) email. Present for external accounts.

isVerified
boolean

Present for internal accounts. For ach, false while micro-deposit verification is outstanding and true once it completes. Absent for external accounts, where verification does not apply.

bankAccount
object

Present when type=ach.

card
object

Present when type=card.

paperCheck
object

Present when type=check.

domesticWire
object

Present when type=domestic-wire.

createdAt
string<date-time>
updatedAt
string<date-time>