---
title: "🧪 Create a deposit"
method: POST
path: "/simulate/deposit"
tags: ["Payment", "snbx"]
---

# 🧪 Create a deposit

`POST /simulate/deposit`

## Request

- Base URL: `https://core.sivo.com`
- URL: `https://core.sivo.com/simulate/deposit`
- Auth: one of:
  - API key in header `Authorization`
  - OAuth 2
    - Authorization code: `https://dashboard.sivo.com/oauth/authorize`
    - Client credentials
    - Token URL: `https://core.sivo.com/oauth/token`
- TypeScript: <https://skmtc.dev/sivo/apis/sivo-advance-api/docs/simulate/deposit/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `Idempotency-Key` string: A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 256 bytes. See [Idempotent Requests](/docs/idempotent-requests).

## Request body

- object
  - `amount` integer, required: Non-negative integer amount in lowest currency denomination. See [Money](/docs/money) for details.
  - `deposit_account_id` string, uuid, required: A [Universally Unique Identifier (UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier)
  - `payer_bankname` string: Non-empty text string
  - `payer_country` string: ISO 3166-1 alpha-2 country code
  - `payer_name` string: Non-empty text string
  - `reference` string: Non-empty text string
  - `statement_ref` string: Non-empty text string
  - `status` 'pending' | 'settled' | 'rejected'

## Response `200`

Successful operation

- object
  - `amount` integer, required: Non-negative integer amount in lowest currency denomination. See [Money](/docs/money) for details.
  - `deposit_account_id` string, uuid, required: A [Universally Unique Identifier (UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier)
  - `payer_bankname` string: Non-empty text string
  - `payer_country` string: ISO 3166-1 alpha-2 country code
  - `payer_name` string: Non-empty text string
  - `reference` string: Non-empty text string
  - `statement_ref` string: Non-empty text string
  - `status` 'pending' | 'settled' | 'rejected'
  - `currency` string, required: ISO 4217 currency code
  - `created_at` string, date-time, required
  - `deposit_type` 'debit' | 'credit', required
  - `fee_amount` integer: Non-negative integer amount in lowest currency denomination. See [Money](/docs/money) for details.
  - `fee_currency` object
    - `currency_code` string, required: ISO 4217 currency code
    - `precision` integer, required: Integer amount in lowest currency denomination. See [Money](/docs/money) for details.
    - `value` string, required: Non-empty text string
  - `id` string, uuid, required: A [Universally Unique Identifier (UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier)

## Changes

- **2026-11-03** `4bbab9699612`: 1 warning, 1 info
  - deleted the `header` request parameter `IdempotencyKey`
  - added the new optional `header` request parameter `Idempotency-Key`

[Operation history](https://skmtc.dev/sivo/apis/sivo-advance-api/changes/simulate/deposit/post.md)

---

[API](https://skmtc.dev/sivo/apis/sivo-advance-api.md) - [All operations](https://skmtc.dev/sivo/apis/sivo-advance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sivo/apis/sivo-advance-api/revisions/4bbab9699612?raw)