Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer token authentication, for client-server calls.

Send the access token issued by POST /v1/auth/token as Authorization: Bearer {token}. The token carries its own program and user context, so the X-Meridian-* headers are not required. See Authentication.

Headers

X-Meridian-Api-Key
string

Server-to-server (HMAC) requests only. Partner API key issued by Meridian during provisioning.

X-Meridian-Timestamp
string

Server-to-server (HMAC) requests only. Current time in milliseconds since the Unix epoch. Must be within 60 seconds of the request.

X-Meridian-Program-Id
string

Server-to-server (HMAC) requests only. Identifies the program context for the request.

X-Meridian-User-Id
string

Server-to-server (HMAC) requests only. Identifies the Meridian user targeted by the request. Required for MULTI_USER integrations; omit for SINGLE_USER.

Path Parameters

beneficiaryId
string
required

ID of the beneficiary — the id returned by POST /v1/beneficiaries or GET /v1/beneficiaries.

Body

application/json

Instrument to attach

Bank account instrument to create for a beneficiary

bankAccount
Beneficiary Bank Account Input · object
required

Bank account to attach

idempotencyKey
string
required

Client-supplied idempotency key; retries with the same key are de-duplicated

Example:

"a1b2c3d4-1111-2222-3333-444455556666"

type
enum<string>
required

Instrument type discriminator

Available options:
BANK_ACCOUNT,
EWALLET,
BLOCKCHAIN_WALLET

Response

The newly created beneficiary instrument

A beneficiary bank account instrument

id
string
required

Unique identifier of the instrument

Example:

"uspi-01JMERINSTR001"

status
string
required

Lifecycle status of the instrument

Example:

"ACTIVE"

displayName
string
required

Display name of the instrument

currency
string
required

Currency of the instrument

Example:

"GBP"

mask
string
required

Masked account identifier

Example:

"1234"

createdAt
string<date-time>
required

Timestamp when the instrument was created

Example:

"2026-04-30T14:00:00Z"

updatedAt
string<date-time>
required

Timestamp when the instrument was last updated

Example:

"2026-04-30T14:00:00Z"

type
enum<string>
required

Instrument type discriminator

Available options:
BANK_ACCOUNT,
EWALLET,
BLOCKCHAIN_WALLET
bankAccount
Beneficiary Instrument Bank Account · object | null

Bank account detail

availableRails
string[]

Rails this instrument can be paid over, as reported by the banking provider. An empty list means the rails are not known yet, not that the instrument cannot be paid.

Example: