UrlPay API V1 v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Прием платежей и выплаты через UrlPay

Base URLs:

https://urlpay.io/api

Authentication

API Key (api-key)
- Parameter Name: Authorization, in: header. API Key аутентификация. Тип - Bearer API ключ можно получить в личном кабинете в настройках магазина

Платежи

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

Code samples

POST /v2/payments

Body parameter

{
  "currency": "rub",
  "amount": "1000.50",
  "uuid": "invoice_123",
  "shopId": 5,
  "description": "Покупка булочек",
  "website_url": "https://example.com",
  "subscribe": null,
  "holdTime": null,
  "language": "ru",
  "items": [
    {
      "description": "string",
      "quantity": 0,
      "price": 0,
      "vat_code": 0,
      "payment_subject": 1,
      "payment_mode": 1,
      "product_code": "string",
      "country_of_origin_code": "string",
      "customs_declaration_number": "string",
      "excise": "string",
      "measurement_unit": 0
    }
  ],
  "sign": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	PaymentRequest	false	none

Example responses

201 Response

{
  "success": true,
  "paymentUrl": "https://site.ru/",
  "id": 1
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

422 Response

{
  "error": "param is missing or the value is empty: article",
  "status": 422
}

Responses

Status	Meaning	Description	Schema
201	Created	Платеж	Inline
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Флаг успеха
» paymentUrl	string	false	none	URL для оплаты
» id	integer	false	none	ID платежа

Получение списка платежей

Code samples

GET /v2/payments

Example responses

200 Response

{
  "items": [
    {
      "id": 1,
      "uuid": "string",
      "amount": "string",
      "currency": "string",
      "description": "string",
      "status": 3
    }
  ]
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

422 Response

{
  "error": "param is missing or the value is empty: article",
  "status": 422
}

Responses

Status	Meaning	Description	Schema
200	OK	Список платежей	Inline
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» items	[Payment]	false	none	[Платеж]
»» id	integer	false	none	ID платежа
»» uuid	string	false	none	none
»» amount	string	false	none	none
»» currency	string	false	none	none
»» description	string	false	none	none
»» status	integer	false	none	Статус платежа: - 0: Создан - 1: В обработке - 2: Отменен - 3: Обработан - 4: Ошибка - 5: Холд - 6: Холд

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
status	4
status	5
status	6

Получение данных по платежу

Code samples

GET /v2/payments/{id}

Example responses

200 Response

{
  "success": true,
  "payment": {
    "id": 1,
    "uuid": "string",
    "amount": "string",
    "currency": "string",
    "description": "string",
    "status": 3
  }
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

422 Response

{
  "error": "param is missing or the value is empty: article",
  "status": 422
}

Responses

Status	Meaning	Description	Schema
200	OK	Платеж	Inline
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Флаг успеха
» payment	Payment	false	none	Платеж
»» id	integer	false	none	ID платежа
»» uuid	string	false	none	none
»» amount	string	false	none	none
»» currency	string	false	none	none
»» description	string	false	none	none
»» status	integer	false	none	Статус платежа: - 0: Создан - 1: В обработке - 2: Отменен - 3: Обработан - 4: Ошибка - 5: Холд - 6: Холд

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
status	4
status	5
status	6

Подтверждение списания средств

Code samples

PUT /v2/payments/{id}/hold

Example responses

200 Response

{
  "success": true
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

422 Response

{
  "error": "param is missing or the value is empty: article",
  "status": 422
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Отмена списания средств

Code samples

DELETE /v2/payments/{id}/hold

Example responses

200 Response

{
  "success": true
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

422 Response

{
  "error": "param is missing or the value is empty: article",
  "status": 422
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Возврат платежа

Code samples

PUT /v2/payments/{id}/refund

Example responses

200 Response

{
  "success": true
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

422 Response

{
  "error": "param is missing or the value is empty: article",
  "status": 422
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Чеки

Получение данных о чеке

Code samples

GET /v2/payments/{id}/receipt

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID платежа, для которого нужно получить чек

Example responses

200 Response

{
  "status": "success",
  "items": [
    {
      "id": 1,
      "daemon_code": "DAEMON123",
      "device_code": "DEVICE456",
      "warnings": [
        "Warning 1",
        "Warning 2"
      ],
      "error": [
        "Error 1",
        "Error 2"
      ],
      "ecr_registration_number": "REG123456",
      "fiscal_document_attribute": 1,
      "fiscal_document_number": 1001,
      "fiscal_receipt_number": 5001,
      "fn_number": "FN123456",
      "fns_site": "https://fns.ru",
      "receipt_datetime": "2023-10-01T12:00:00Z",
      "shift_number": 1,
      "total": 1000.5,
      "ofd_inn": "1234567890",
      "ofd_receipt_url": "https://ofd.example.com/receipt/1",
      "status": "success",
      "uuid": "invoice_123",
      "created_at": "2023-10-01T12:00:00Z",
      "updated_at": "2023-10-01T12:00:00Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Успешное получение данных о чеке	Inline
401	Unauthorized	Неавторизованный доступ	Inline
404	Not Found	Чек не найден	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» items	[Receipt]	false	none	none
»» id	integer	false	none	Уникальный идентификатор чека
»» daemon_code	string	false	none	Код демона, если применимо
»» device_code	string	false	none	Код устройства, если применимо
»» warnings	[string]	false	none	Список предупреждений, связанных с чеком
»» error	[string]	false	none	Список ошибок, связанных с чеком
»» ecr_registration_number	string	false	none	Регистрационный номер ККТ
»» fiscal_document_attribute	integer	false	none	Атрибут фискального документа
»» fiscal_document_number	integer	false	none	Номер фискального документа
»» fiscal_receipt_number	integer	false	none	Номер фискального чека
»» fn_number	string	false	none	Номер фискального накопителя
»» fns_site	string	false	none	Сайт ФНС
»» receipt_datetime	string(date-time)	false	none	Дата и время создания чека
»» shift_number	integer	false	none	Номер смены
»» total	number(float)	false	none	Общая сумма чека
»» ofd_inn	string	false	none	ИНН ОФД
»» ofd_receipt_url	string	false	none	URL для получения чека у ОФД
»» status	string	false	none	Статус чека
»» uuid	string	false	none	Уникальный идентификатор заказа
»» created_at	string(date-time)	false	none	Дата и время создания записи о чеке
»» updated_at	string(date-time)	false	none	Дата и время последнего обновления записи о чеке

Status Code 401

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» message	string	false	none	none

Status Code 404

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» message	string	false	none	none

Подписки

Получение списка подписок

Code samples

GET /v2/subscribes

Example responses

200 Response

{
  "items": [
    {
      "id": 1,
      "description": "string",
      "status": 0,
      "currency": "rub",
      "amount": "1000.50",
      "start_date": "string",
      "next_pay_date": "string",
      "interval": null
    }
  ]
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

422 Response

{
  "error": "param is missing or the value is empty: article",
  "status": 422
}

Responses

Status	Meaning	Description	Schema
200	OK	Список подписок	Inline
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» items	[Subscribe]	false	none	[Подписка]
»» id	integer	false	none	ID подписки
»» description	string	false	none	none
»» status	integer	false	none	none
»» currency	string	false	none	Валюта оплаты (rub)
»» amount	string	false	none	Сумма оплаты с копейками строкой 100.50
»» start_date	string	false	none	Стартовая дата
»» next_pay_date	string	false	none	Следующая дата оплаты
»» interval	string	false	none	Интервал списания, варианты данных - Day, Week, Month

Отмена подписки

Code samples

DELETE /v2/subscribes/{id}

Example responses

200 Response

{
  "success": true
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

422 Response

{
  "error": "param is missing or the value is empty: article",
  "status": 422
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

callbacks

Отправить запрос на callback для ресурса Payment

Code samples

POST /payments/callback

Отправляет запрос на callback по настроенному URL продавца (магазина), если он задан.

Body parameter

{
  "id": 12345,
  "amount": 100.5,
  "currency": "RUB",
  "uuid": "external-uuid-123",
  "payment_status": "success"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» id	body	integer	false	ID платежа
» amount	body	number(float)	false	Сумма платежа
» currency	body	string	false	Валюта платежа (например, RUB)
» uuid	body	string	false	Внешний идентификатор платежа
» payment_status	body	string	false	Статус платежа для колбэка (например, 'success')

Enumerated Values

Parameter	Value
» payment_status	success
» payment_status	cancel

Responses

Status	Meaning	Description	Schema
200	OK	Запрос обратного вызова успешно отправлен	None
400	Bad Request	Некорректные данные о платеже или отсутствует URL для обратного вызова	None
404	Not Found	Платеж не найден	None

Балансы

Получение балансов магазина

Code samples

GET /v2/shops/{shopId}/balances

Parameters

Name	In	Type	Required	Description
shopId	path	integer	true	ID магазина

Example responses

200 Response

{
  "success": true,
  "data": {
    "balances": [
      {
        "shop_id": 5,
        "currency": "rub",
        "balance": 1000.5,
        "hold": 200,
        "available": 800.5
      }
    ]
  }
}

401 Response

{
  "error": "unauthorized",
  "status": 401
}

403 Response

{
  "success": false,
  "message": "Магазин не найден или не принадлежит текущему пользователю"
}

422 Response

{
  "success": false,
  "message": "Ошибка валидации",
  "errors": {
    "shop_id": [
      "Поле shop_id должно быть целым числом."
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Список балансов магазина	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Флаг успеха
» data	object	false	none	none
»» balances	[Balance]	false	none	[Баланс магазина]
»»» shop_id	integer	false	none	ID магазина
»»» currency	string	false	none	Валюта баланса
»»» balance	number(float)	false	none	Общий баланс
»»» hold	number(float)	false	none	Сумма на холде
»»» available	number(float)	false	none	Доступная сумма (balance - hold)

Выплаты

Получение списка выплат

Code samples

GET /v2/card-payouts

Parameters

Name	In	Type	Required	Description
shop_id	query	integer	false	ID магазина для фильтрации
status	query	string	false	Статус выплаты для фильтрации
currency	query	string	false	Валюта для фильтрации
payout_type	query	string	false	Тип выплаты для фильтрации
date_from	query	string(date)	false	Дата начала периода
date_to	query	string(date)	false	Дата окончания периода
per_page	query	integer	false	Количество элементов на странице (1-100)
page	query	integer	false	Номер страницы
search	query	string	false	Поиск по external_id, имени получателя, номеру карты/счета, описанию

Enumerated Values

Parameter	Value
payout_type	card
payout_type	account

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "shop_id": 5,
      "external_id": "payout_123",
      "payout_type": "card",
      "recipient_card_number": "1234****3456",
      "recipient_account_number": "40817810099910004312",
      "recipient_bank_code": "044525225",
      "recipient_name": "Иванов Иван Иванович",
      "recipient_phone": "+79001234567",
      "amount": 1000.5,
      "amount_with_fee": 1005.5,
      "currency": "rub",
      "status": "pending",
      "description": "Выплата за услуги",
      "comment": "Дополнительная информация",
      "metadata": {},
      "cancelled_reason": "Запрос от клиента",
      "processed_at": "2023-10-01T12:00:00Z",
      "created_at": "2023-10-01T10:00:00Z",
      "updated_at": "2023-10-01T12:00:00Z",
      "user": {
        "id": 1,
        "name": "Иван Иванов",
        "email": "user@example.com"
      },
      "shop": {
        "id": 5,
        "name": "Мой магазин",
        "url": "https://myshop.com"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "last_page": 10,
    "per_page": 15,
    "total": 150
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Список выплат	Inline
401	Unauthorized	Unauthorized	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» data	[CardPayout]	false	none	[Выплата]
»» id	integer	false	none	ID выплаты
»» user_id	integer	false	none	ID пользователя
»» shop_id	integer	false	none	ID магазина
»» external_id	string	false	none	Внешний ID выплаты
»» payout_type	string	false	none	Тип выплаты
»» recipient_card_number	string	false	none	Номер карты получателя
»» recipient_account_number	string	false	none	Номер счета получателя
»» recipient_bank_code	string	false	none	Код банка получателя
»» recipient_name	string	false	none	ФИО получателя
»» recipient_phone	string	false	none	Телефон получателя
»» amount	number(float)	false	none	Сумма выплаты
»» amount_with_fee	number(float)	false	none	Сумма выплаты с комиссией
»» currency	string	false	none	Валюта выплаты
»» status	string	false	none	Статус выплаты
»» description	string	false	none	Описание выплаты
»» comment	string	false	none	Комментарий к выплате
»» metadata	object	false	none	Дополнительные данные
»» cancelled_reason	string	false	none	Причина отмены
»» processed_at	string(date-time)	false	none	Дата обработки
»» created_at	string(date-time)	false	none	Дата создания
»» updated_at	string(date-time)	false	none	Дата обновления
»» user	object	false	none	Информация о пользователе
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» email	string	false	none	none
»» shop	object	false	none	Информация о магазине
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» url	string	false	none	none
» pagination	Pagination	false	none	Информация о пагинации
»» current_page	integer	false	none	Текущая страница
»» last_page	integer	false	none	Последняя страница
»» per_page	integer	false	none	Элементов на странице
»» total	integer	false	none	Общее количество элементов

Enumerated Values

Property	Value
payout_type	card
payout_type	account

Создание новой выплаты

Code samples

POST /v2/card-payouts

Body parameter

{
  "shop_id": 5,
  "external_id": "payout_123",
  "payout_type": "card",
  "recipient_card_number": "1234567890123456",
  "recipient_account_number": "40817810099910004312",
  "recipient_bank_code": "044525225",
  "recipient_name": "Иванов Иван Иванович",
  "recipient_phone": "+79001234567",
  "amount": 1000.5,
  "currency": "rub",
  "description": "Выплата за услуги",
  "comment": "Дополнительная информация",
  "metadata": {
    "order_id": "12345",
    "department": "sales"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	CardPayoutRequest	true	none

Example responses

201 Response

{
  "success": true,
  "message": "Выплата успешно создана",
  "data": {
    "id": 1,
    "user_id": 1,
    "shop_id": 5,
    "external_id": "payout_123",
    "payout_type": "card",
    "recipient_card_number": "1234****3456",
    "recipient_account_number": "40817810099910004312",
    "recipient_bank_code": "044525225",
    "recipient_name": "Иванов Иван Иванович",
    "recipient_phone": "+79001234567",
    "amount": 1000.5,
    "amount_with_fee": 1005.5,
    "currency": "rub",
    "status": "pending",
    "description": "Выплата за услуги",
    "comment": "Дополнительная информация",
    "metadata": {},
    "cancelled_reason": "Запрос от клиента",
    "processed_at": "2023-10-01T12:00:00Z",
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-01T12:00:00Z",
    "user": {
      "id": 1,
      "name": "Иван Иванов",
      "email": "user@example.com"
    },
    "shop": {
      "id": 5,
      "name": "Мой магазин",
      "url": "https://myshop.com"
    }
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	Выплата успешно создана	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Выплаты для магазина отключены	None
404	Not Found	Магазин не найден	None
422	Unprocessable Entity	Ошибка валидации данных	None
500	Internal Server Error	Ошибка при создании выплаты	None

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» message	string	false	none	none
» data	CardPayout	false	none	Выплата
»» id	integer	false	none	ID выплаты
»» user_id	integer	false	none	ID пользователя
»» shop_id	integer	false	none	ID магазина
»» external_id	string	false	none	Внешний ID выплаты
»» payout_type	string	false	none	Тип выплаты
»» recipient_card_number	string	false	none	Номер карты получателя
»» recipient_account_number	string	false	none	Номер счета получателя
»» recipient_bank_code	string	false	none	Код банка получателя
»» recipient_name	string	false	none	ФИО получателя
»» recipient_phone	string	false	none	Телефон получателя
»» amount	number(float)	false	none	Сумма выплаты
»» amount_with_fee	number(float)	false	none	Сумма выплаты с комиссией
»» currency	string	false	none	Валюта выплаты
»» status	string	false	none	Статус выплаты
»» description	string	false	none	Описание выплаты
»» comment	string	false	none	Комментарий к выплате
»» metadata	object	false	none	Дополнительные данные
»» cancelled_reason	string	false	none	Причина отмены
»» processed_at	string(date-time)	false	none	Дата обработки
»» created_at	string(date-time)	false	none	Дата создания
»» updated_at	string(date-time)	false	none	Дата обновления
»» user	object	false	none	Информация о пользователе
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» email	string	false	none	none
»» shop	object	false	none	Информация о магазине
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» url	string	false	none	none

Enumerated Values

Property	Value
payout_type	card
payout_type	account

Массовое создание выплат

Code samples

POST /v2/card-payouts/bulk

Body parameter

{
  "shop_id": 5,
  "payouts": [
    {
      "external_id": "payout_123",
      "payout_type": "card",
      "recipient_card_number": "1234567890123456",
      "recipient_account_number": "40817810099910004312",
      "recipient_bank_code": "044525225",
      "recipient_name": "Иванов Иван Иванович",
      "recipient_phone": "+79001234567",
      "amount": 1000.5,
      "currency": "rub",
      "description": "Выплата за услуги",
      "comment": "Дополнительная информация",
      "metadata": {}
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	BulkCardPayoutRequest	true	none

Example responses

201 Response

{
  "success": true,
  "message": "Выплаты успешно созданы",
  "data": {
    "created_count": 5,
    "payouts": [
      {
        "id": 1,
        "user_id": 1,
        "shop_id": 5,
        "external_id": "payout_123",
        "payout_type": "card",
        "recipient_card_number": "1234****3456",
        "recipient_account_number": "40817810099910004312",
        "recipient_bank_code": "044525225",
        "recipient_name": "Иванов Иван Иванович",
        "recipient_phone": "+79001234567",
        "amount": 1000.5,
        "amount_with_fee": 1005.5,
        "currency": "rub",
        "status": "pending",
        "description": "Выплата за услуги",
        "comment": "Дополнительная информация",
        "metadata": {},
        "cancelled_reason": "Запрос от клиента",
        "processed_at": "2023-10-01T12:00:00Z",
        "created_at": "2023-10-01T10:00:00Z",
        "updated_at": "2023-10-01T12:00:00Z",
        "user": {
          "id": 1,
          "name": "Иван Иванов",
          "email": "user@example.com"
        },
        "shop": {
          "id": 5,
          "name": "Мой магазин",
          "url": "https://myshop.com"
        }
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	Выплаты успешно созданы	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Выплаты для магазина отключены	None
404	Not Found	Магазин не найден	None
422	Unprocessable Entity	Ошибка валидации данных	None
500	Internal Server Error	Ошибка при создании выплат	None

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» message	string	false	none	none
» data	object	false	none	none
»» created_count	integer	false	none	none
»» payouts	[CardPayout]	false	none	[Выплата]
»»» id	integer	false	none	ID выплаты
»»» user_id	integer	false	none	ID пользователя
»»» shop_id	integer	false	none	ID магазина
»»» external_id	string	false	none	Внешний ID выплаты
»»» payout_type	string	false	none	Тип выплаты
»»» recipient_card_number	string	false	none	Номер карты получателя
»»» recipient_account_number	string	false	none	Номер счета получателя
»»» recipient_bank_code	string	false	none	Код банка получателя
»»» recipient_name	string	false	none	ФИО получателя
»»» recipient_phone	string	false	none	Телефон получателя
»»» amount	number(float)	false	none	Сумма выплаты
»»» amount_with_fee	number(float)	false	none	Сумма выплаты с комиссией
»»» currency	string	false	none	Валюта выплаты
»»» status	string	false	none	Статус выплаты
»»» description	string	false	none	Описание выплаты
»»» comment	string	false	none	Комментарий к выплате
»»» metadata	object	false	none	Дополнительные данные
»»» cancelled_reason	string	false	none	Причина отмены
»»» processed_at	string(date-time)	false	none	Дата обработки
»»» created_at	string(date-time)	false	none	Дата создания
»»» updated_at	string(date-time)	false	none	Дата обновления
»»» user	object	false	none	Информация о пользователе
»»»» id	integer	false	none	none
»»»» name	string	false	none	none
»»»» email	string	false	none	none
»»» shop	object	false	none	Информация о магазине
»»»» id	integer	false	none	none
»»»» name	string	false	none	none
»»»» url	string	false	none	none

Enumerated Values

Property	Value
payout_type	card
payout_type	account

Получение статистики по выплатам

Code samples

GET /v2/card-payouts/statistics

Parameters

Name	In	Type	Required	Description
shop_id	query	integer	false	ID магазина для фильтрации
date_from	query	string(date)	false	Дата начала периода
date_to	query	string(date)	false	Дата окончания периода

Example responses

200 Response

{
  "success": true,
  "data": {
    "total_count": 150,
    "total_amount": 50000,
    "by_status": {
      "property1": {
        "text": "Ожидает обработки",
        "count": 25,
        "amount": 10000
      },
      "property2": {
        "text": "Ожидает обработки",
        "count": 25,
        "amount": 10000
      }
    },
    "by_currency": {
      "property1": {
        "text": "Российский рубль",
        "count": 150,
        "amount": 50000
      },
      "property2": {
        "text": "Российский рубль",
        "count": 150,
        "amount": 50000
      }
    },
    "by_type": {
      "property1": {
        "text": "На карту",
        "count": 100,
        "amount": 35000
      },
      "property2": {
        "text": "На карту",
        "count": 100,
        "amount": 35000
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Статистика по выплатам	Inline
401	Unauthorized	Unauthorized	None
404	Not Found	Магазин не найден	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» data	PayoutStatistics	false	none	Статистика по выплатам
»» total_count	integer	false	none	Общее количество выплат
»» total_amount	number(float)	false	none	Общая сумма выплат
»» by_status	object	false	none	Статистика по статусам
»»» additionalProperties	object	false	none	none
»»»» text	string	false	none	none
»»»» count	integer	false	none	none
»»»» amount	number(float)	false	none	none
»» by_currency	object	false	none	Статистика по валютам
»»» additionalProperties	object	false	none	none
»»»» text	string	false	none	none
»»»» count	integer	false	none	none
»»»» amount	number(float)	false	none	none
»» by_type	object	false	none	Статистика по типам
»»» additionalProperties	object	false	none	none
»»»» text	string	false	none	none
»»»» count	integer	false	none	none
»»»» amount	number(float)	false	none	none

Получение доступных валют для выплат

Code samples

GET /v2/card-payouts/currencies

Example responses

200 Response

{
  "success": true,
  "data": {
    "rub": "Российский рубль"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Список доступных валют	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» data	object	false	none	none
»» additionalProperties	string	false	none	none

Получение доступных типов выплат

Code samples

GET /v2/card-payouts/types

Example responses

200 Response

{
  "success": true,
  "data": {
    "card": "На карту",
    "account": "На счет"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Список доступных типов выплат	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» data	object	false	none	none
»» additionalProperties	string	false	none	none

Получение доступных статусов выплат

Code samples

GET /v2/card-payouts/statuses

Example responses

200 Response

{
  "success": true,
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Список доступных статусов	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» data	object	false	none	none
»» additionalProperties	string	false	none	none

Получение выплаты по внешнему ID

Code samples

GET /v2/card-payouts/external/{external_id}

Parameters

Name	In	Type	Required	Description
external_id	path	string	true	Внешний ID выплаты
shop_id	query	integer	false	ID магазина для дополнительной фильтрации

Example responses

200 Response

{
  "success": true,
  "data": {
    "id": 1,
    "user_id": 1,
    "shop_id": 5,
    "external_id": "payout_123",
    "payout_type": "card",
    "recipient_card_number": "1234****3456",
    "recipient_account_number": "40817810099910004312",
    "recipient_bank_code": "044525225",
    "recipient_name": "Иванов Иван Иванович",
    "recipient_phone": "+79001234567",
    "amount": 1000.5,
    "amount_with_fee": 1005.5,
    "currency": "rub",
    "status": "pending",
    "description": "Выплата за услуги",
    "comment": "Дополнительная информация",
    "metadata": {},
    "cancelled_reason": "Запрос от клиента",
    "processed_at": "2023-10-01T12:00:00Z",
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-01T12:00:00Z",
    "user": {
      "id": 1,
      "name": "Иван Иванов",
      "email": "user@example.com"
    },
    "shop": {
      "id": 5,
      "name": "Мой магазин",
      "url": "https://myshop.com"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Данные выплаты	Inline
401	Unauthorized	Unauthorized	None
404	Not Found	Выплата не найдена	None
422	Unprocessable Entity	Ошибка валидации данных	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» data	CardPayout	false	none	Выплата
»» id	integer	false	none	ID выплаты
»» user_id	integer	false	none	ID пользователя
»» shop_id	integer	false	none	ID магазина
»» external_id	string	false	none	Внешний ID выплаты
»» payout_type	string	false	none	Тип выплаты
»» recipient_card_number	string	false	none	Номер карты получателя
»» recipient_account_number	string	false	none	Номер счета получателя
»» recipient_bank_code	string	false	none	Код банка получателя
»» recipient_name	string	false	none	ФИО получателя
»» recipient_phone	string	false	none	Телефон получателя
»» amount	number(float)	false	none	Сумма выплаты
»» amount_with_fee	number(float)	false	none	Сумма выплаты с комиссией
»» currency	string	false	none	Валюта выплаты
»» status	string	false	none	Статус выплаты
»» description	string	false	none	Описание выплаты
»» comment	string	false	none	Комментарий к выплате
»» metadata	object	false	none	Дополнительные данные
»» cancelled_reason	string	false	none	Причина отмены
»» processed_at	string(date-time)	false	none	Дата обработки
»» created_at	string(date-time)	false	none	Дата создания
»» updated_at	string(date-time)	false	none	Дата обновления
»» user	object	false	none	Информация о пользователе
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» email	string	false	none	none
»» shop	object	false	none	Информация о магазине
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» url	string	false	none	none

Enumerated Values

Property	Value
payout_type	card
payout_type	account

Получение информации о выплате

Code samples

GET /v2/card-payouts/{id}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID выплаты

Example responses

200 Response

{
  "success": true,
  "data": {
    "id": 1,
    "user_id": 1,
    "shop_id": 5,
    "external_id": "payout_123",
    "payout_type": "card",
    "recipient_card_number": "1234****3456",
    "recipient_account_number": "40817810099910004312",
    "recipient_bank_code": "044525225",
    "recipient_name": "Иванов Иван Иванович",
    "recipient_phone": "+79001234567",
    "amount": 1000.5,
    "amount_with_fee": 1005.5,
    "currency": "rub",
    "status": "pending",
    "description": "Выплата за услуги",
    "comment": "Дополнительная информация",
    "metadata": {},
    "cancelled_reason": "Запрос от клиента",
    "processed_at": "2023-10-01T12:00:00Z",
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-01T12:00:00Z",
    "user": {
      "id": 1,
      "name": "Иван Иванов",
      "email": "user@example.com"
    },
    "shop": {
      "id": 5,
      "name": "Мой магазин",
      "url": "https://myshop.com"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Данные выплаты	Inline
401	Unauthorized	Unauthorized	None
404	Not Found	Выплата не найдена	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» data	CardPayout	false	none	Выплата
»» id	integer	false	none	ID выплаты
»» user_id	integer	false	none	ID пользователя
»» shop_id	integer	false	none	ID магазина
»» external_id	string	false	none	Внешний ID выплаты
»» payout_type	string	false	none	Тип выплаты
»» recipient_card_number	string	false	none	Номер карты получателя
»» recipient_account_number	string	false	none	Номер счета получателя
»» recipient_bank_code	string	false	none	Код банка получателя
»» recipient_name	string	false	none	ФИО получателя
»» recipient_phone	string	false	none	Телефон получателя
»» amount	number(float)	false	none	Сумма выплаты
»» amount_with_fee	number(float)	false	none	Сумма выплаты с комиссией
»» currency	string	false	none	Валюта выплаты
»» status	string	false	none	Статус выплаты
»» description	string	false	none	Описание выплаты
»» comment	string	false	none	Комментарий к выплате
»» metadata	object	false	none	Дополнительные данные
»» cancelled_reason	string	false	none	Причина отмены
»» processed_at	string(date-time)	false	none	Дата обработки
»» created_at	string(date-time)	false	none	Дата создания
»» updated_at	string(date-time)	false	none	Дата обновления
»» user	object	false	none	Информация о пользователе
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» email	string	false	none	none
»» shop	object	false	none	Информация о магазине
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» url	string	false	none	none

Enumerated Values

Property	Value
payout_type	card
payout_type	account

Обновление выплаты (только для статуса pending)

Code samples

PUT /v2/card-payouts/{id}

Body parameter

{
  "recipient_card_number": "1234567890123456",
  "recipient_account_number": "40817810099910004312",
  "recipient_bank_code": "044525225",
  "recipient_name": "Иванов Иван Иванович",
  "recipient_phone": "+79001234567",
  "amount": 1000.5,
  "description": "Выплата за услуги",
  "comment": "Дополнительная информация",
  "metadata": {}
}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID выплаты
body	body	CardPayoutUpdateRequest	true	none

Example responses

200 Response

{
  "success": true,
  "message": "Выплата успешно обновлена",
  "data": {
    "id": 1,
    "user_id": 1,
    "shop_id": 5,
    "external_id": "payout_123",
    "payout_type": "card",
    "recipient_card_number": "1234****3456",
    "recipient_account_number": "40817810099910004312",
    "recipient_bank_code": "044525225",
    "recipient_name": "Иванов Иван Иванович",
    "recipient_phone": "+79001234567",
    "amount": 1000.5,
    "amount_with_fee": 1005.5,
    "currency": "rub",
    "status": "pending",
    "description": "Выплата за услуги",
    "comment": "Дополнительная информация",
    "metadata": {},
    "cancelled_reason": "Запрос от клиента",
    "processed_at": "2023-10-01T12:00:00Z",
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-01T12:00:00Z",
    "user": {
      "id": 1,
      "name": "Иван Иванов",
      "email": "user@example.com"
    },
    "shop": {
      "id": 5,
      "name": "Мой магазин",
      "url": "https://myshop.com"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Выплата успешно обновлена	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Можно редактировать только выплаты со статусом "Ожидает обработки"	None
404	Not Found	Выплата не найдена	None
422	Unprocessable Entity	Ошибка валидации данных	None
500	Internal Server Error	Ошибка при обновлении выплаты	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» message	string	false	none	none
» data	CardPayout	false	none	Выплата
»» id	integer	false	none	ID выплаты
»» user_id	integer	false	none	ID пользователя
»» shop_id	integer	false	none	ID магазина
»» external_id	string	false	none	Внешний ID выплаты
»» payout_type	string	false	none	Тип выплаты
»» recipient_card_number	string	false	none	Номер карты получателя
»» recipient_account_number	string	false	none	Номер счета получателя
»» recipient_bank_code	string	false	none	Код банка получателя
»» recipient_name	string	false	none	ФИО получателя
»» recipient_phone	string	false	none	Телефон получателя
»» amount	number(float)	false	none	Сумма выплаты
»» amount_with_fee	number(float)	false	none	Сумма выплаты с комиссией
»» currency	string	false	none	Валюта выплаты
»» status	string	false	none	Статус выплаты
»» description	string	false	none	Описание выплаты
»» comment	string	false	none	Комментарий к выплате
»» metadata	object	false	none	Дополнительные данные
»» cancelled_reason	string	false	none	Причина отмены
»» processed_at	string(date-time)	false	none	Дата обработки
»» created_at	string(date-time)	false	none	Дата создания
»» updated_at	string(date-time)	false	none	Дата обновления
»» user	object	false	none	Информация о пользователе
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» email	string	false	none	none
»» shop	object	false	none	Информация о магазине
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» url	string	false	none	none

Enumerated Values

Property	Value
payout_type	card
payout_type	account

Отмена выплаты

Code samples

POST /v2/card-payouts/{id}/cancel

Body parameter

{
  "reason": "Запрос от клиента"
}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	ID выплаты
body	body	object	false	none
» reason	body	string	false	Причина отмены

Example responses

200 Response

{
  "success": true,
  "message": "Выплата успешно отменена",
  "data": {
    "id": 1,
    "user_id": 1,
    "shop_id": 5,
    "external_id": "payout_123",
    "payout_type": "card",
    "recipient_card_number": "1234****3456",
    "recipient_account_number": "40817810099910004312",
    "recipient_bank_code": "044525225",
    "recipient_name": "Иванов Иван Иванович",
    "recipient_phone": "+79001234567",
    "amount": 1000.5,
    "amount_with_fee": 1005.5,
    "currency": "rub",
    "status": "pending",
    "description": "Выплата за услуги",
    "comment": "Дополнительная информация",
    "metadata": {},
    "cancelled_reason": "Запрос от клиента",
    "processed_at": "2023-10-01T12:00:00Z",
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-01T12:00:00Z",
    "user": {
      "id": 1,
      "name": "Иван Иванов",
      "email": "user@example.com"
    },
    "shop": {
      "id": 5,
      "name": "Мой магазин",
      "url": "https://myshop.com"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Выплата успешно отменена	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Можно отменить только выплаты в статусе ожидания или обработки	None
404	Not Found	Выплата не найдена	None
422	Unprocessable Entity	Ошибка валидации данных	None
500	Internal Server Error	Ошибка при отмене выплаты	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» message	string	false	none	none
» data	CardPayout	false	none	Выплата
»» id	integer	false	none	ID выплаты
»» user_id	integer	false	none	ID пользователя
»» shop_id	integer	false	none	ID магазина
»» external_id	string	false	none	Внешний ID выплаты
»» payout_type	string	false	none	Тип выплаты
»» recipient_card_number	string	false	none	Номер карты получателя
»» recipient_account_number	string	false	none	Номер счета получателя
»» recipient_bank_code	string	false	none	Код банка получателя
»» recipient_name	string	false	none	ФИО получателя
»» recipient_phone	string	false	none	Телефон получателя
»» amount	number(float)	false	none	Сумма выплаты
»» amount_with_fee	number(float)	false	none	Сумма выплаты с комиссией
»» currency	string	false	none	Валюта выплаты
»» status	string	false	none	Статус выплаты
»» description	string	false	none	Описание выплаты
»» comment	string	false	none	Комментарий к выплате
»» metadata	object	false	none	Дополнительные данные
»» cancelled_reason	string	false	none	Причина отмены
»» processed_at	string(date-time)	false	none	Дата обработки
»» created_at	string(date-time)	false	none	Дата создания
»» updated_at	string(date-time)	false	none	Дата обновления
»» user	object	false	none	Информация о пользователе
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» email	string	false	none	none
»» shop	object	false	none	Информация о магазине
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» url	string	false	none	none

Enumerated Values

Property	Value
payout_type	card
payout_type	account

Schemas

CardPayoutRequest

{
  "shop_id": 5,
  "external_id": "payout_123",
  "payout_type": "card",
  "recipient_card_number": "1234567890123456",
  "recipient_account_number": "40817810099910004312",
  "recipient_bank_code": "044525225",
  "recipient_name": "Иванов Иван Иванович",
  "recipient_phone": "+79001234567",
  "amount": 1000.5,
  "currency": "rub",
  "description": "Выплата за услуги",
  "comment": "Дополнительная информация",
  "metadata": {
    "order_id": "12345",
    "department": "sales"
  }
}

Запрос создания выплаты

Properties

Name	Type	Required	Restrictions	Description
shop_id	integer	true	none	ID магазина
external_id	string	false	none	Внешний ID выплаты (должен быть уникальным)
payout_type	string	true	none	Тип выплаты
recipient_card_number	string	false	none	Номер карты получателя (обязательно для типа card)
recipient_account_number	string	false	none	Номер счета получателя (обязательно для типа account)
recipient_bank_code	string	false	none	Код банка получателя
recipient_name	string	true	none	ФИО получателя
recipient_phone	string	false	none	Телефон получателя
amount	number(float)	true	none	Сумма выплаты
currency	string	true	none	Валюта выплаты
description	string	false	none	Описание выплаты
comment	string	false	none	Комментарий к выплате
metadata	object	false	none	Дополнительные данные

Enumerated Values

Property	Value
payout_type	card
payout_type	account
currency	rub

CardPayoutUpdateRequest

{
  "recipient_card_number": "1234567890123456",
  "recipient_account_number": "40817810099910004312",
  "recipient_bank_code": "044525225",
  "recipient_name": "Иванов Иван Иванович",
  "recipient_phone": "+79001234567",
  "amount": 1000.5,
  "description": "Выплата за услуги",
  "comment": "Дополнительная информация",
  "metadata": {}
}

Запрос обновления выплаты

Properties

Name	Type	Required	Restrictions	Description
recipient_card_number	string	false	none	none
recipient_account_number	string	false	none	none
recipient_bank_code	string	false	none	none
recipient_name	string	false	none	none
recipient_phone	string	false	none	none
amount	number(float)	false	none	none
description	string	false	none	none
comment	string	false	none	none
metadata	object	false	none	none

BulkCardPayoutRequest

{
  "shop_id": 5,
  "payouts": [
    {
      "external_id": "payout_123",
      "payout_type": "card",
      "recipient_card_number": "1234567890123456",
      "recipient_account_number": "40817810099910004312",
      "recipient_bank_code": "044525225",
      "recipient_name": "Иванов Иван Иванович",
      "recipient_phone": "+79001234567",
      "amount": 1000.5,
      "currency": "rub",
      "description": "Выплата за услуги",
      "comment": "Дополнительная информация",
      "metadata": {}
    }
  ]
}

Запрос массового создания выплат

Properties

Name	Type	Required	Restrictions	Description
shop_id	integer	true	none	ID магазина
payouts	[object]	true	none	Массив выплат для создания
» external_id	string	false	none	none
» payout_type	string	true	none	none
» recipient_card_number	string	false	none	none
» recipient_account_number	string	false	none	none
» recipient_bank_code	string	false	none	none
» recipient_name	string	true	none	none
» recipient_phone	string	false	none	none
» amount	number(float)	true	none	none
» currency	string	true	none	none
» description	string	false	none	none
» comment	string	false	none	none
» metadata	object	false	none	none

Enumerated Values

Property	Value
payout_type	card
payout_type	account
currency	rub

CardPayout

{
  "id": 1,
  "user_id": 1,
  "shop_id": 5,
  "external_id": "payout_123",
  "payout_type": "card",
  "recipient_card_number": "1234****3456",
  "recipient_account_number": "40817810099910004312",
  "recipient_bank_code": "044525225",
  "recipient_name": "Иванов Иван Иванович",
  "recipient_phone": "+79001234567",
  "amount": 1000.5,
  "amount_with_fee": 1005.5,
  "currency": "rub",
  "status": "pending",
  "description": "Выплата за услуги",
  "comment": "Дополнительная информация",
  "metadata": {},
  "cancelled_reason": "Запрос от клиента",
  "processed_at": "2023-10-01T12:00:00Z",
  "created_at": "2023-10-01T10:00:00Z",
  "updated_at": "2023-10-01T12:00:00Z",
  "user": {
    "id": 1,
    "name": "Иван Иванов",
    "email": "user@example.com"
  },
  "shop": {
    "id": 5,
    "name": "Мой магазин",
    "url": "https://myshop.com"
  }
}

Выплата

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	ID выплаты
user_id	integer	false	none	ID пользователя
shop_id	integer	false	none	ID магазина
external_id	string	false	none	Внешний ID выплаты
payout_type	string	false	none	Тип выплаты
recipient_card_number	string	false	none	Номер карты получателя
recipient_account_number	string	false	none	Номер счета получателя
recipient_bank_code	string	false	none	Код банка получателя
recipient_name	string	false	none	ФИО получателя
recipient_phone	string	false	none	Телефон получателя
amount	number(float)	false	none	Сумма выплаты
amount_with_fee	number(float)	false	none	Сумма выплаты с комиссией
currency	string	false	none	Валюта выплаты
status	string	false	none	Статус выплаты
description	string	false	none	Описание выплаты
comment	string	false	none	Комментарий к выплате
metadata	object	false	none	Дополнительные данные
cancelled_reason	string	false	none	Причина отмены
processed_at	string(date-time)	false	none	Дата обработки
created_at	string(date-time)	false	none	Дата создания
updated_at	string(date-time)	false	none	Дата обновления
user	object	false	none	Информация о пользователе
» id	integer	false	none	none
» name	string	false	none	none
» email	string	false	none	none
shop	object	false	none	Информация о магазине
» id	integer	false	none	none
» name	string	false	none	none
» url	string	false	none	none

Enumerated Values

Property	Value
payout_type	card
payout_type	account

PayoutStatistics

{
  "total_count": 150,
  "total_amount": 50000,
  "by_status": {
    "property1": {
      "text": "Ожидает обработки",
      "count": 25,
      "amount": 10000
    },
    "property2": {
      "text": "Ожидает обработки",
      "count": 25,
      "amount": 10000
    }
  },
  "by_currency": {
    "property1": {
      "text": "Российский рубль",
      "count": 150,
      "amount": 50000
    },
    "property2": {
      "text": "Российский рубль",
      "count": 150,
      "amount": 50000
    }
  },
  "by_type": {
    "property1": {
      "text": "На карту",
      "count": 100,
      "amount": 35000
    },
    "property2": {
      "text": "На карту",
      "count": 100,
      "amount": 35000
    }
  }
}

Статистика по выплатам

Properties

Name	Type	Required	Restrictions	Description
total_count	integer	false	none	Общее количество выплат
total_amount	number(float)	false	none	Общая сумма выплат
by_status	object	false	none	Статистика по статусам
» additionalProperties	object	false	none	none
»» text	string	false	none	none
»» count	integer	false	none	none
»» amount	number(float)	false	none	none
by_currency	object	false	none	Статистика по валютам
» additionalProperties	object	false	none	none
»» text	string	false	none	none
»» count	integer	false	none	none
»» amount	number(float)	false	none	none
by_type	object	false	none	Статистика по типам
» additionalProperties	object	false	none	none
»» text	string	false	none	none
»» count	integer	false	none	none
»» amount	number(float)	false	none	none

Pagination

{
  "current_page": 1,
  "last_page": 10,
  "per_page": 15,
  "total": 150
}

Информация о пагинации

Properties

Name	Type	Required	Restrictions	Description
current_page	integer	false	none	Текущая страница
last_page	integer	false	none	Последняя страница
per_page	integer	false	none	Элементов на странице
total	integer	false	none	Общее количество элементов

PaymentRequest

{
  "currency": "rub",
  "amount": "1000.50",
  "uuid": "invoice_123",
  "shopId": 5,
  "description": "Покупка булочек",
  "website_url": "https://example.com",
  "subscribe": null,
  "holdTime": null,
  "language": "ru",
  "items": [
    {
      "description": "string",
      "quantity": 0,
      "price": 0,
      "vat_code": 0,
      "payment_subject": 1,
      "payment_mode": 1,
      "product_code": "string",
      "country_of_origin_code": "string",
      "customs_declaration_number": "string",
      "excise": "string",
      "measurement_unit": 0
    }
  ],
  "sign": "string"
}

Запрос платежа

Properties

Name	Type	Required	Restrictions	Description
currency	string	true	none	Валюта оплаты (rub)
amount	number	true	none	Сумма оплаты с копейками строкой 100.50
uuid	string	true	none	Uuid заказа на строное магазина
shopId	integer	true	none	ID магазина из ЛК
description	string	true	none	Описание платежа
website_url	string	false	none	Ссылка на сайт магазина
subscribe	string	false	none	Подписка, если не требуется то null, варианты данных - Day, Week, Month
holdTime	integer	false	none	Время в секундах, на которое происходит холд денег клиента. После гое истечения происходит отмена. Либо нужно подтвердить списание
language	string	false	none	Язык формы оплаты
items	[object]	true	none	none
» description	string	true	none	Описание товара
» quantity	number	true	none	Количество товара
» price	number	true	none	Цена товара
» vat_code	integer	true	none	Код ставки НДС. Возможные значения: - 0: Без НДС - 1: НДС по ставке 0% - 2: НДС чека по ставке 10% - 3: НДС чека по ставке 18% - 4: НДС чека по расчетной ставке 10/110 - 5: НДС чека по расчетной ставке 18/118 - 6: НДС чека по ставке 20% - 7: НДС чека по расчетной ставке 20/120
» payment_subject	integer	true	none	Код предмета платежа. Возможные значения: - 1: Товар - 2: Подакцизный товар - 3: Работа - 4: Услуга - 5: Ставка азартной игры - 6: Выигрыш азартной игры - 7: Лотерейный билет - 8: Выигрыш лотереи - 9: Предоставление РИД - 10: Платеж - 11: Агентское вознаграждение - 12: Выплата - 13: Иной предмет расчета - 14: Имущественное право - 15: Внереализационный доход - 16: Иные платежи и взносы - 17: Торговый сбор - 19: Залог - 20: Расход - 21: Взносы на обязательное пенсионное страхование ИП - 22: Взносы на обязательное пенсионное страхование - 23: Взносы на обязательное медицинское страхование ИП - 24: Взносы на обязательное медицинское страхование - 25: Взносы на обязательное социальное страхование - 26: Платеж казино
» payment_mode	integer	true	none	Код метода платежа - 1: Полная предоплата - 2: Частичная предоплата - 3: Аванс - 4: Полный расчет - 5: Частичный расчет и кредит - 6: Кредит - 7: Выплата по кредиту
» product_code	string¦null	false	none	none
» country_of_origin_code	string¦null	false	none	none
» customs_declaration_number	string¦null	false	none	none
» excise	string¦null	false	none	none
» measurement_unit	integer¦null	false	none	Код единицы измерения. Возможные значения: - 0: Штука или единица (шт. или ед.) - 10: Грамм (г) - 11: Килограмм (кг) - 12: Тонна (т) - 20: Сантиметр (см) - 21: Дециметр (дм) - 22: Метр (м) - 30: Квадратный сантиметр (кв. см) - 31: Квадратный дециметр (кв. дм) - 32: Квадратный метр (кв. м) - 40: Миллилитр (мл) - 41: Литр (л) - 42: Кубический метр (куб. м) - 50: Киловатт час (кВт · ч) - 51: Гигакалория (Гкал) - 70: Сутки (сутки) - 71: Час (час) - 72: Минута (мин) - 73: Секунда (с) - 80: Килобайт (Кбайт) - 81: Мегабайт (Мбайт) - 82: Гигабайт (Гбайт) - 83: Терабайт (Тбайт) - 255: Применяется при использовании иных единиц измерения, не поименованных в п. п. 1 - 23
sign	string	true	none	Подпись данных состоящая из конкатенации параметров currency, amount, shopId и секретного ключа из ЛК хешированная в sha1

Enumerated Values

Property	Value
currency	rub
subscribe	Day
subscribe	Week
subscribe	Month
vat_code	0
vat_code	1
vat_code	2
vat_code	3
vat_code	4
vat_code	5
vat_code	6
vat_code	7
payment_subject	1
payment_subject	2
payment_subject	3
payment_subject	4
payment_subject	5
payment_subject	6
payment_subject	7
payment_subject	8
payment_subject	9
payment_subject	10
payment_subject	11
payment_subject	12
payment_subject	13
payment_subject	14
payment_subject	15
payment_subject	16
payment_subject	17
payment_subject	19
payment_subject	20
payment_subject	21
payment_subject	22
payment_subject	23
payment_subject	24
payment_subject	25
payment_subject	26
payment_mode	1
payment_mode	2
payment_mode	3
payment_mode	4
payment_mode	5
payment_mode	6
payment_mode	7
measurement_unit	0
measurement_unit	10
measurement_unit	11
measurement_unit	12
measurement_unit	20
measurement_unit	21
measurement_unit	22
measurement_unit	30
measurement_unit	31
measurement_unit	32
measurement_unit	40
measurement_unit	41
measurement_unit	42
measurement_unit	50
measurement_unit	51
measurement_unit	70
measurement_unit	71
measurement_unit	72
measurement_unit	73
measurement_unit	80
measurement_unit	81
measurement_unit	82
measurement_unit	83
measurement_unit	255

Payment

{
  "id": 1,
  "uuid": "string",
  "amount": "string",
  "currency": "string",
  "description": "string",
  "status": 3
}

Платеж

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	ID платежа
uuid	string	false	none	none
amount	string	false	none	none
currency	string	false	none	none
description	string	false	none	none
status	integer	false	none	Статус платежа: - 0: Создан - 1: В обработке - 2: Отменен - 3: Обработан - 4: Ошибка - 5: Холд - 6: Холд

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
status	4
status	5
status	6

{
  "id": 1,
  "description": "string",
  "status": 0,
  "currency": "rub",
  "amount": "1000.50",
  "start_date": "string",
  "next_pay_date": "string",
  "interval": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	ID подписки
description	string	false	none	none
status	integer	false	none	none
currency	string	false	none	Валюта оплаты (rub)
amount	string	false	none	Сумма оплаты с копейками строкой 100.50
start_date	string	false	none	Стартовая дата
next_pay_date	string	false	none	Следующая дата оплаты
interval	string	false	none	Интервал списания, варианты данных - Day, Week, Month

ArticleFlareTag

{
  "name": "string",
  "bg_color_hex": "string",
  "text_color_hex": "string"
}

Flare tag of the article

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
bg_color_hex	string¦null	false	none	Background color (hexadecimal)
text_color_hex	string¦null	false	none	Text color (hexadecimal)

Receipt

{
  "id": 1,
  "daemon_code": "DAEMON123",
  "device_code": "DEVICE456",
  "warnings": [
    "Warning 1",
    "Warning 2"
  ],
  "error": [
    "Error 1",
    "Error 2"
  ],
  "ecr_registration_number": "REG123456",
  "fiscal_document_attribute": 1,
  "fiscal_document_number": 1001,
  "fiscal_receipt_number": 5001,
  "fn_number": "FN123456",
  "fns_site": "https://fns.ru",
  "receipt_datetime": "2023-10-01T12:00:00Z",
  "shift_number": 1,
  "total": 1000.5,
  "ofd_inn": "1234567890",
  "ofd_receipt_url": "https://ofd.example.com/receipt/1",
  "status": "success",
  "uuid": "invoice_123",
  "created_at": "2023-10-01T12:00:00Z",
  "updated_at": "2023-10-01T12:00:00Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	Уникальный идентификатор чека
daemon_code	string	false	none	Код демона, если применимо
device_code	string	false	none	Код устройства, если применимо
warnings	[string]	false	none	Список предупреждений, связанных с чеком
error	[string]	false	none	Список ошибок, связанных с чеком
ecr_registration_number	string	false	none	Регистрационный номер ККТ
fiscal_document_attribute	integer	false	none	Атрибут фискального документа
fiscal_document_number	integer	false	none	Номер фискального документа
fiscal_receipt_number	integer	false	none	Номер фискального чека
fn_number	string	false	none	Номер фискального накопителя
fns_site	string	false	none	Сайт ФНС
receipt_datetime	string(date-time)	false	none	Дата и время создания чека
shift_number	integer	false	none	Номер смены
total	number(float)	false	none	Общая сумма чека
ofd_inn	string	false	none	ИНН ОФД
ofd_receipt_url	string	false	none	URL для получения чека у ОФД
status	string	false	none	Статус чека
uuid	string	false	none	Уникальный идентификатор заказа
created_at	string(date-time)	false	none	Дата и время создания записи о чеке
updated_at	string(date-time)	false	none	Дата и время последнего обновления записи о чеке

Balance

{
  "shop_id": 5,
  "currency": "rub",
  "balance": 1000.5,
  "hold": 200,
  "available": 800.5
}

Баланс магазина

Properties

Name	Type	Required	Restrictions	Description
shop_id	integer	false	none	ID магазина
currency	string	false	none	Валюта баланса
balance	number(float)	false	none	Общий баланс
hold	number(float)	false	none	Сумма на холде
available	number(float)	false	none	Доступная сумма (balance - hold)

UrlPay API V1 v1.0.0

Платежи

Parameters

Responses

Response Schema

Responses

Response Schema

Responses

Response Schema

Responses

Response Schema

Responses

Response Schema

Responses

Response Schema

Чеки

Parameters

Responses

Response Schema

Подписки

Responses

Response Schema

Responses

Response Schema

callbacks

Parameters

Responses

Балансы

Parameters

Responses

Response Schema

Выплаты

Parameters

Responses

Response Schema

Parameters

Responses

Response Schema

Parameters

Responses

Response Schema

Parameters

Responses

Response Schema

Responses

Response Schema

Responses

Response Schema

Responses

Response Schema

Parameters

Responses

Response Schema

Parameters

Responses

Response Schema

Parameters

Responses

Response Schema

Parameters

Responses

Response Schema

CardPayoutRequest

CardPayoutUpdateRequest

BulkCardPayoutRequest

CardPayout

PayoutStatistics

Pagination

PaymentRequest

Payment

Subscribe

ArticleFlareTag

Receipt

Balance