Skip to main content
POST
Add a Deposit Instruction to an Account

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

accountId
string
required

ID of the account — the id returned by GET /v1/accounts.

Body

application/json

Name and idempotency key for the new deposit instruction

Request payload for adding a deposit instruction to an account

name
string
required

Display name for the new deposit instruction. 1-64 characters; need not be unique.

Example:

"Invoices EU"

idempotencyKey
string
required

Client-supplied idempotency key; retries with the same key are de-duplicated. If a retry reuses the key with a different name, the name from the first request wins.

Example:

"a1b2c3d4"

Response

Provisioning started

Accepted request to add a deposit instruction; it appears on the account once provisioned

accountId
string
required

The account the deposit instruction is being added to

name
string
required

Display name of the new deposit instruction

status
string
required

Always PENDING; poll GET /v1/accounts/{accountId} for the new instruction

Example:

"PENDING"

idempotencyKey
string
required

The idempotency key supplied on the request