Create an account

Authorizations

api-key

string

header

required

Headers

Idempotency-Key

string

Unique key (UUID recommended) that makes a create request safe to retry by replaying the original response; retained 24h per partner.

Maximum string length: 255

Melio-Sonar-Token

string

Signed MelioSonar session token from the initiating device, used for risk evaluation; invalid or expired tokens return 403.

Melio-Entity-Id

string

required

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

Body

application/json

Create an account. ownershipType selects internal (an internal account the entity pays from) or external (an external account the entity pays to); type selects the instrument. Supported combinations: internal ach, internal card, external ach, external check, external domestic-wire, external virtual-card, external international-fx, external international-gusd.

The two international types additionally require the partner to be enabled for international payouts, and the entity to have completed international onboarding — see PUT /entities/{entityId}/beneficial-owners. A business that has not returns 409 ENTITY_ONBOARDING_INCOMPLETE listing the outstanding fields.

ownershipType

enum<string>

required

Available options:

internal

type

enum<string>

required

Available options:

ach

bankAccount

object

required

The account and routing numbers. Available to selected partners; otherwise add the account through the Plaid link flow. When accepted, the account is created in a verified state.

Hide child attributes

bankAccount.accountNumber

string

required

bankAccount.routingNumber

string

required

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

Hide child attributes

metadata.{key}

string

Maximum string length: 100

nickname

string

Response

Account created.

string

Opaque account id (acct_)

externalId

string

Maximum string length: 255

Pattern: ^[A-Za-z0-9_-]+$

metadata

object

Hide child attributes

metadata.{key}

string

Maximum string length: 100

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,

international-fx,

international-gusd

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.

Hide child attributes

bankAccount.accountType

enum<string>

Available options:

checking,

savings

bankAccount.routingNumber

string

bankAccount.accountNumberLast4

string

card

object

Present when type=card.

Hide child attributes

card.lastFourDigits

string

card.network

string

card.expiration

string

MM/YY

paperCheck

object

Present when type=check.

Hide child attributes

paperCheck.printName

string

paperCheck.address

object

Address as returned in responses; fields may be absent when the stored record is incomplete.

Hide child attributes

paperCheck.address.line1

string

paperCheck.address.line2

string

paperCheck.address.city

string

paperCheck.address.state

string

paperCheck.address.postalCode

string

paperCheck.address.aptNumber

string

paperCheck.address.countryCode

string

domesticWire

object

Present when type=domestic-wire.

Hide child attributes

domesticWire.routingNumber

string

ABA routing number of the receiving bank

domesticWire.accountNumberLast4

string

domesticWire.address

object

Address as returned in responses; fields may be absent when the stored record is incomplete.

Hide child attributes

domesticWire.address.line1

string

domesticWire.address.line2

string

domesticWire.address.city

string

domesticWire.address.state

string

domesticWire.address.postalCode

string

domesticWire.address.aptNumber

string

domesticWire.address.countryCode

string

internationalFx

object

Present when type=international-fx. The submitted bank identifiers are stored encrypted, so only the last four characters are returned.

Hide child attributes

internationalFx.currency

string

ISO 4217 code the counterparty is paid in

internationalFx.bankCountryCode

string

internationalFx.bankName

string

internationalFx.accountIdentifierLast4

string

Last four characters of the IBAN or account number on file.

internationalFx.address

object

Address as returned in responses; fields may be absent when the stored record is incomplete.

Hide child attributes

internationalFx.address.line1

string

internationalFx.address.line2

string

internationalFx.address.city

string

internationalFx.address.state

string

internationalFx.address.postalCode

string

internationalFx.address.aptNumber

string

internationalFx.address.countryCode

string

internationalGusd

object

Present when type=international-gusd.

Hide child attributes

internationalGusd.walletAddressLast4

string

Last four characters of the wallet address

createdAt

string<date-time>

updatedAt

string<date-time>

Entities

Accounts

Attachments

Payments

Tools

Webhooks

Authorizations

Headers

Body

Response