Skip to content

Создание депозита

POST /api/v1/requests/deposit/create

Параметры для генерации подписи

callback_url::cents::currency::customer::merchant::order_id::payment_type::reject_url::success_url

Параметры

  • merchantrequred

    UUID мерчанта

  • order_idrequred

    Идентификатор, который позволяет идентифицировать сделку в системе мерчанта

  • centsrequred

    Сумма в копейках. Например, сумма 3руб. 12коп. - это число 312

    • Минимальное и максимальное значение можно узнать с помощью GET /api/v1/requests/limit
  • currencyrequred

    Валюта сделки.

    • Доступные значения: RUB, UZS, KZT, TJS
    • Список доступных значений можно увидеть в GET /api/v1/requests/limit
  • payment_typerequred

    Выбранные тип перевода.

    • Список доступных значений можно увидеть в GET /api/v1/requests/limit

    Примеры значений:

    • any_bank - перевод на карту любого доступного банка
    • sbp - СБП переводы по номеру телефона
    • sber - перевод на карту Сбербанк
    • account_number - перевод по номеру счета в банке
  • customer

    Уникальный индентификатор покупателя. В качестве значения может быть имя, email, любое id в системе мерчанта

  • callback_url

    URL на веб-сайте Мерчанта, куда будет отправлен POST запрос о статусе выполнения вызываемых методов (настраивается в Личном кабинете):

    • Если параметр передан – используется его значение.
    • Если нет – значение в настройках личного кабинета
  • success_url

    URl для рекдиректа с платежной страницы после подтверждения платежа

  • reject_url

    URl для рекдиректа с платежной страницы после реджекта платежа

Пример запроса

POST /api/v1/requests/deposit/create
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    order_id: "Order999",
    cents: 20000,
    currency: "RUB",
    payment_type: "sber",
    customer: "customer_email@example.com",
    callback_url: "https://api.merchant_sitem.com/callback_url"
    success_url: "https://api.merchant_sitem.com/success_url"
    reject_url: "https://api.merchant_sitem.com/reject_url"
}

Пример ответа

{
    uuid: "6dae5b5b-a218-45d1-bd96-a0cf54aff6a6", 
    merchant: "0ebe12eb-740c-4635-8cbd-4f0c12002673"
    order_id: "external_merchant_id",
    state: "created",
    kind: "deposit",
    amount_cents: 20000,
    amount_currency: "RUB",
    seller: "artisan", 
    buyer: "customer_uniq_id",
    payment_data: {
        name: "Елена Кузнецова", 
        number: "1111 1111 1111 1111",
        url: 'https://payment_url.example/6dae5b5b-a218-45d1-bd96-a0cf54aff6a6'
    },
    payment_bill_url: 'https://s3-server/bill_image'
}

Обьект payment_data

Обьект payment_data содержит все необходимые поля для совершения перевода. В зависимости от выбранного способа оплаты (поле payment_type) список полей может различаться.

Возможные поля:

  • number

    Номер, по которому нужно совершить перевод. Может быть номером карты, номером телефона, номером счета

  • name

    Имя владельца платежных реквизитов

  • bank_name

    Назвние банка. Присутствует у переводов по номеру счета и сбп

  • bic

    Реквизиты бик для перевода по номеру счета

  • payment_reason

    Описание перевода для перевода по номеру счета

  • url

    Ссылка на платежную страницу