---
title: "Creates a deposit request"
method: POST
path: "/deposits"
tags: ["Deposits"]
---

# Creates a deposit request

`POST /deposits`

## Headers

- `Content-Type` string, required
- `X-Date` string, date-time, required
- `X-Login` string, required
- `Authorization` string, required
- `X-Idempotency-Key` string

## Request body

- object
  - `country` string, required — Country of the deposit.
  - `amount` number, required — Amount of the deposit.
  - `invoice_id` string, required — Unique deposit ID on your side.
  - `currency` string, required — Currency of the deposit.
  - `request_payer_data_on_validation_failure` boolean — Flag specifying if you want to ignore errors because of invalid phone, zip_code and/or city's state.
  - `payer` object, required — Object containing details about the customer. See 'Payer object' section for details.
  - `payment_method` string, required — Payment method code.
  - `payment_types` string[] — Array of payment methods' types to show the customer on our Hosted Checkout.
  - `reported_info` object — Object containing details about the bank account from which the deposit will be made. Used in ONE_SHOT mode to auto-detect user's payment.
  - `bank_account` object — Object containing details about the customer's bank account. Used to enforce a close-loop policy.
  - `bonus_amount` number — Used to show the customer a bonus amount (Pay 100, receive 120).
  - `bonus_relative` boolean — Used to define if the bonus_amount was specified as an absolute value or as a percentage.
  - `strikethrough_price` number — Used to show the customer a strikethrough amount.
  - `description` string — Description of the deposit.
  - `client_ip` string — Valid IPv4/6 Address of the customer.
  - `device_id` string — Unique customer's device ID created using our JS library.
  - `language` string — Language of the view page.
  - `back_url` string — HTTPS URL used to redirect the customer in case of cancelling the deposit.
  - `success_url` string — HTTPS URL used to redirect the customer in case of success.
  - `error_url` string — HTTPS URL used to redirect the customer in case of error while generating the payment.
  - `notification_url` string — HTTPS URL used to send the notifications about deposit's change of status.
  - `logo` string — HTTPS URL used as the Merchant logo on our cashier page.
  - `test` boolean — Used to mark a deposit as test. If true, the deposit will not affect the merchant's balance.
  - `mobile` boolean — Used to specify if the redirection will be made on a mobile device.
  - `early_release` boolean — Used to specify if the deposit should be released earlier.
  - `fee_on_payer` boolean — Used to specify if you want to let the customer assume the deposit fee.

## Response `201`

Successful creation of the transaction

- object
  - `checkout_type` string
  - `redirect_url` string
  - `deposit_id` integer
  - `user_id` string
  - `merchant_invoice_id` string
  - `payment_info` object
    - `type` string
    - `payment_method` string
    - `payment_method_name` string
    - `amount` number
    - `currency` string
    - `expiration_date` string, date-time
    - `created_at` string, date-time
    - `metadata` object
      - `Beneficiary_name` string
      - `Bank` string
      - `account` string
      - `provider_reference` string

## Other responses

- `400` — Field validation error. Check details

---

[API](https://skmtc.net/lime-pay/apis/deposit-creation-endpoint.md) · [All operations](https://skmtc.net/lime-pay/apis/deposit-creation-endpoint/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lime-pay/deposit-creation-endpoint/revisions/dc2fd4cd3140/schema)