Создание счета на оплату

Обновлено 20 февраля 2025

POST

/invoices

Создайте счет на оплату.

Запрос

application/json

Body

user_id

object

oneOf

partner_client_id
user_uid
encrypted_sub_id
partner_client_sub_id

partner_client_id

string

required

Внешний идентификатор клиента партнера

ptype

integer

Возможные значения: [0, 1]

Тип оплаты счета:

0 — одностадийная оплата.
1 — двухстадийная оплата.

Если параметр не указан, формируется одностадийная оплата.

invoice

object

Информация о создаваемом счете

purchaser

object

Блок информации о покупателе

string

Электронный адрес клиента

phone

string

Номер телефона клиента

contact

string

Способ связи с клиентом

delivery_info

object

Информация о доставке

address

object

Адрес

country

string

Страна

city

string

Город

address

string

Адрес

delivery_type

string

Тип доставки

description

string

Дополнительная информация о доставке

invoice_params

object[]

Дополнительные параметры, уточняющие товарную позицию

Array [

key

string

required

Название параметра

value

string

required

Значение параметра

]

order

object

required

order_id

string

Идентификатор заказа.

Должен быть уникален в рамках выделенного для приложения service_id, иначе не будет создан новый invoice_id

order_number

string

Номер заказа для отображения покупателю и отслеживания статуса заказа.

Рекомендуется сделать его максимально понятным и простым для восприятия

order_date

date-time

Дата и время заказа в формате RFC 3339

service_id

string

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

amount

integer

required

Сумма счета без разделителя, в копейках. Например, 1 рубль передается в этом поле как 100.

Если в запросе указывается корзина товаров, то это поле должно быть равно сумме стоимости всех товаров в корзине sum(order_bundle.item_amount).

currency

string

required

Код валюты в формате ISO 4217.

Поддерживается только значение RUB

purpose

string

Краткое назначение платежа.

Отображается при оплате/подтверждении безакцептного списания клиентом

description

string

Описание платежа для отображения клиенту

language

string

Язык текстовых полей в формате BCP 47.

Поддерживается только значение ru-RU

expiration_date

date-time

Дата и время истечения срока оплаты в формате RFC 3339.

По умолчанию на оплату отводится 20 минут от момента регистрации платежа. Поле передается, если нужно изменить это время

tax_system

integer

Система налогообложения:

0 — общая;
1 — упрощенная, доход;
2 — упрощенная, доход минус расход;
3 — единый налог на вмененный доход;
4 — единый сельскохозяйственный налог;
5 — патентная система налогообложения.

order_bundle

object[]

Описание корзины покупок для передачи в налоговую и формирования фискального чека.

Не требуется заполнять, например, при создании счета на предавторизацию.

Обязательно нужно указывать в счетах на оплату, иначе оплата не состоится

Array [

position_id

integer

required

Номер позиции в корзине для добавления в фискальный чек.

Должен быть уникален в рамках заказа

name

string

required

Наименование или описание товарной позиции

item_params

object[]

Дополнительные параметры, уточняющие товарную позицию

Array [

key

string

required

Название параметра

value

string

required

Значение параметра

]

quantity

object

Описание количественных характеристик определенной позиции корзины

value

number

required

Количество товара в позиции.

Для разделителя используйте точку. Не более 3 знаков после запятой

measure

string

required

Единица измерения товара в позиции

item_amount

integer

Сумма стоимости всех товарных позиций одного positionId, в копейках

currency

string

Код валюты в формате ISO 4217.

Поддерживается только значение RUB

item_code

string

Номер (идентификатор) товарной позиции в системе магазина.

Параметр должен быть уникальным в рамках запроса

item_price

integer

Стоимость одного товара в позиции без разделителя, в копейках

discount_type

string

Тип скидки на товарную позицию

discount_value

number

Значение скидки на товарную позицию.

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

interest_type

string

Тип агентской комиссии за продажу товара.

Применимо только для агентской схемы

interest_value

number

Значение агентской комиссии за продажу товара.

Применимо только для агентской схемы

tax_type

integer

Ставка НДС:

0 — без НДС;
1 — НДС по ставке 0%
2 — НДС чека по ставке 10%
3 — НДС чека по ставке 18%
4 — НДС чека по расчетной ставке 10/110;
5 — НДС чека по расчетной ставке 18/118;
6 — НДС чека по ставке 20%
7 — НДС чека по расчетной ставке 20/120.

Значение «НДС по ставке 0%» отличается от варианта «без НДС» только формированием чека в зависимости от системы налогообложения. По сумме налога разницы нет

tax_sum

integer

Сумма налога, высчитанная продавцом, без разделителя, в копейках

image

url

Ссылка на картинку

]

Ответы

200
400
401
default

Идентификатор созданного счета

application/json

Схема
Пример из схемы

Schema

anyOf

invoice_id

invoice_id

string

required

Идентификатор счета

error

object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

bad input parameter

application/json

Схема
Пример из схемы

Schema

error

object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

Unexpected error

application/json

Схема
Пример из схемы

Schema

error

object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

Это полезный материал?

Создание счета на оплату

Запрос﻿

Body

Ответы﻿

Запрос

Ответы