Emulate an incoming deposit: an account transfer with bankId, a token transfer without

POST /sandbox/deposits

Emulate an incoming deposit: an account transfer with bankId, a token transfer without

cURL

curl --request POST \
  --url https://api.example.com/sandbox/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "500.00"
}
'

200

{
  "depositId": "<string>",
  "status": "awaitingSignature",
  "token": "USDC",
  "amount": "500.00",
  "currency": "<string>",
  "idempotencyKey": "<string>",
  "payinId": "pi_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "transactionId": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "credited": "500.00",
  "fee": "500.00",
  "feeCurrency": "<string>",
  "rate": "500.00",
  "txHash": "<string>",
  "pollUrl": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

Idempotency-Key · string | null

Your own key for this write, ^[A-Za-z0-9._:-]{1,128}$. A retry with the same key replays the first answer; the same key with a different request is refused.

Example:

"po-inv-2026-114"

Body

application/json

amount · string · required

Test amount to credit.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Example:

"500.00"

bankId · string | null

Virtual-account identifier for an emulated account transfer.

Pattern: ^(?:bnk_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"bnk_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

token · enum<string> | null

Digital asset for an emulated on-chain transfer.

Available options: USDC, EURC

remitter · string | null

Originator name reported with the credit.

Maximum string length: 140

paymentReference · string | null

Reference reported with the credit.

Maximum string length: 140

Response

200

application/json

Successful Response

depositId · string · required

Stable identifier for the emulated credit.

status · enum<string> · required

Current public lifecycle status of the emulated credit.

Available options: awaitingSignature, submitted, settled, failed, refunded

token · enum<string> · required

Digital asset credited after settlement.

Available options: USDC, EURC

amount · string · required

Source amount supplied to the emulator.

Example:

"500.00"

currency · string · required

Source currency or digital asset.

idempotencyKey · string · required

Caller-supplied key that binds retries to this credit.

payinId · string | null

Incoming-transfer identifier, when completing a pay-in.

Pattern: ^(?:pi_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"pi_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

transactionId · string | null

Ledger transaction identifier, when created.

Pattern: ^(?:txn_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

credited · string | null

Amount delivered in the settlement asset.

Example:

"500.00"

fee · string | null

Fee charged by the emulated route.

Example:

"500.00"

feeCurrency · string | null

Currency in which the fee is charged.

rate · string | null

Conversion rate from source to settlement amount.

Example:

"500.00"

txHash · string | null

On-chain transaction hash, when applicable.

pollUrl · string | null

Relative API URL to poll while processing continues.