Skip to main content
POST
/
v1
/
accounts
/
{accountId}
/
simulate-deposit
Send a Mock Deposit
curl --request POST \
  --url https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/simulate-deposit \
  --header 'Content-Type: application/json' \
  --data '
{
  "depositInstructionId": "uspay-deposit-instruction-id",
  "amount": "250.00"
}
'
{
  "message": "<string>"
}

Headers

Authorization
string

Bearer authentication header of the form Bearer {token}. Required for client-server (JWT) authentication. See Authentication.

X-Meridian-Program-Id
string

Identifies the program context for the request. Required for server-to-server (HMAC) authentication. See Authentication.

X-Meridian-User-Id
string

Identifies the Meridian user targeted by the request. Required for server-to-server (HMAC) authentication with MULTI_USER integrations; omit for SINGLE_USER. See Authentication.

X-Meridian-Api-Key
string

Partner API key issued by Meridian during provisioning. Required for server-to-server (HMAC) authentication. See Authentication.

X-Meridian-Timestamp
string

Current time in milliseconds since the Unix epoch. Must be within 60 seconds of the request. Required for server-to-server (HMAC) authentication. See Authentication.

X-Meridian-Signature
string

HMAC SHA-256 signature of the canonical request string, computed per request. Required for server-to-server (HMAC) authentication. See Authentication for how to construct it.

Path Parameters

accountId
string
required

ID of the balance account to deposit into — the id returned by GET /v1/accounts (e.g. uspay-...).

Body

application/json

The deposit instruction to credit and the amount to deposit.

depositInstructionId
string
required

The id of the deposit instruction to credit — an opaque identifier such as uspay-..., NOT a rail name like ACH or WIRE. Each deposit instruction is a funding rail (ACH, Fedwire, etc.) configured on the account that an inbound deposit would arrive through. To find it, call GET /v1/accounts/{accountId} and copy the id of the desired entry from the depositInstructions array (match on its rail.label, e.g. Fedwire for a wire). Passing anything that is not an existing instruction id returns 404.

Example:

"uspay-rvrsmt8vngju3kea5mm6fcck"

amount
string
required

Amount to deposit, as a decimal string in the account's currency (e.g. 100.00). Must be greater than zero.

Example:

"100.00"

Response

Deposit simulation accepted; settles out of band

message
string | null