---
title: "Simulate Deposit Creation"
method: POST
path: "/v1/simulation/deposit"
tags: ["Simulator"]
---

# Simulate Deposit Creation

`POST /v1/simulation/deposit`

You can use this endpoint to simulate deposits into your global account. This is only available in the sandbox environment.

## Headers

- `x-on-behalf-of` string
- `x-idempotency-key` string, uuid

## Request body

- SimulateCreateDepositRequest
  - `amount` number, required — The amount to deposit.
  - `currency` string, required — Three-letter currency code
  - `receiver_account_number` string — The receiver's account number.
  - `sender_swift_code` string, required — Swift code of the beneficiary's bank account.
  - `sender_account_number` string — The sender's account number.
  - `sender_country` string — Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
  - `sender_name` string — The customer-facing business name.

## Response `200`

Deposit simulated successfully.

- SimulateCreateDepositResponse
  - `deposit_id` string, required — The deposit id.
  - `short_reference_id` string, required — The reference generated by the system to identify the entity.
  - `amount` string, required — The amount of the deposit.
  - `currency` string, required — Three-letter currency code
  - `deposit_status` 'PENDING' | 'COMPLETED' | 'FAILED', required — The status of the deposit.
  - `create_time` string — Create time at which the object was created.
  - `complete_time` string, required — Completed time at which the object was created.
  - `receiver_account_number` string, required — Account number, mostly for non-european countries, either account_number or iban should be filled. Only English letters (uppercase and lowercase) and digits are allowed; dashes or other special characters are not permitted.
  - `sender` object, required — Details of the sender who initiated the deposit.
    - `sender_name` string — The customer-facing business name.
    - `sender_country` string — Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
    - `sender_account_number` string — Account number, mostly for non-european countries, either account_number or iban should be filled. Only English letters (uppercase and lowercase) and digits are allowed; dashes or other special characters are not permitted.
    - `sender_swift_code` string — Swift code of the beneficiary's bank account.

---

[API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)