Документация по работе с API
С помощью API вы можете получать информацию о чеках, для которых вы отправили данные через Paybox.
Для обращения к ресурсу чеков, будут доступны следующие методы:
Для обращения к ресурсу чеков, будут доступны следующие методы:
- POST v1/receipts - Создание чека
- GET v1/receipts - Получение списка чеков
- GET v1/receipts/{receipt_id} - Получение информации по чеку
Справочник методов API - Чеки (для РФ)
Объект чека (pg_receipt) содержит актуальную информацию о чеке, созданном для платежа или возврата.
Объект чека
Вложенные параметры объекта company
Вложенные параметры массива positions
Вложенные параметры объекта positions.mark_quantity
Вложенные параметры массива positions.payment_object_industry_details
Вложенные параметры объекта positions.mark_code_type
Вложенные параметры объекта positions.supplier
Вложенные параметры массива settlements
Вложенные параметры объекта additional_user_props
Вложенные параметры массива receipt_industry_details
Вложенные параметры объекта receipt_operating_details
Пример объекта pg_receipt
{
"data": {
"merchant_id": "542088",
"receipt_id": "bb938d6c-6c1c-44a0-aa54-32c3e14fddb7",
"operation_type": "sell",
"receipt_format": "ru_1_05",
"status": "registered",
"fiscal_document_number": 10605,
"fiscal_storage_number": "9999078900006286",
"fiscal_attribute": 923085333,
"registered_at": "29.03.2023 17:37:00",
"created_at": "29.03.2023 20:39:16",
"fiscal_provider_id": "5e402526-0c20-41c3-b30a-b52e7f903922",
"positions": [
{
"name": "Товар №1",
"quantity": 2,
"price": 50,
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 100
},
{
"name": "Товар №2",
"quantity": 1,
"price": 100,
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 100
}
],
"total": 200,
"settlements": [
{
"type": "cashless",
"sum": 200
}
],
"receipt_method": "separately",
"error": null,
"link": "https: //consumer.1-ofd-test.ru/v1?fn=9999078900006286&fp=923085333&i=10605&t=20230329T173700&s=7&n=2",
"payment_id": "764239789"
}
}
Запрос позволяет отправить данные для формирования чека в вашу онлайн-кассу.
С помощью данного запроса можно сформировать чек зачёта предоплаты, если вы используете способ Чек вместе с платежом. Также, необходимо использовать данный запрос для создания чека прихода и чека возврата прихода, если у вас подключен способ Чек отдельно от платежа.
С помощью данного запроса можно сформировать чек зачёта предоплаты, если вы используете способ Чек вместе с платежом. Также, необходимо использовать данный запрос для создания чека прихода и чека возврата прихода, если у вас подключен способ Чек отдельно от платежа.
Создание чека
Вложенные параметры объекта customer
Вложенные параметры объекта company
Вложенные параметры массива positions
Вложенные параметры объекта positions.mark_quantity
Вложенные параметры массива positions.payment_object_industry_details
Вложенные параметры объекта positions.mark_code_type
Вложенные параметры объекта positions.supplier
Вложенные параметры массива settlements
Вложенные параметры объекта additional_user_props
Вложенные параметры массива receipt_industry_details
Вложенные параметры объекта receipt_operating_details
Пример запроса
curl --location --request POST 'https://api.paybox.money/v5/receipts' \
--header 'Accept: application/json' \
--header 'X-JWS-Signature: {{Ваш JWS-токен}}' \
--header 'Content-Type: application/json' \
--data-raw \
'{
"receipt_format": "ru_1_05",
"merchant_id": 542088,
"payment_id": 764239789,
"operation_type": "sell",
"customer": {
"email": "customer@mail.ru"
},
"positions": [
{
"price": 50.00,
"name": "Товар №1",
"quantity": 2.00,
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods"
},
{
"price": 100.00,
"name": "Товра №2",
"quantity": 1.00,
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods"
}
],
"settlements": [
{
"type": "cashless",
"sum": 200.00
}
]
}'
Пример тела ответа
{
"data": {
"merchant_id": "542088",
"receipt_id": "adec9d48-be2a-4bf4-8ca1-3432fd8920c5",
"operation_type": "sell",
"receipt_format": "ru_1_05",
"status": "pending",
"fiscal_document_number": "",
"fiscal_storage_number": null,
"fiscal_attribute": "",
"registered_at": null,
"created_at": "10.04.202315:34:12",
"fiscal_provider_id": null,
"positions": [
{
"name": "Товар №1",
"quantity": 2,
"price": 50,
"measure": "piece",
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 10
},
{
"name": "Товар №2",
"quantity": 1,
"price": 100,
"measure": "piece",
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 2
}
],
"total": 200,
"settlements": [
{
"type": "cashless",
"sum": 200
}
],
"company": {
"inn": "5544332219",
"email": "customer@mail.ru",
"tax_system": "osn",
"payment_address": "shop.ru"
},
"receipt_method": "separately",
"error": null,
"link": null,
"payment_id": "764239789"
}
}
Данный запрос позволяет получить список чеков магазина, отфильтрованный по определённым критериям. Критерии могут быть различными, например, список можно отфильтровать по номеру платежа или возврата, по наименованию товара или сумме чека.
Параметры запроса
Параметры запроса
Получение списка чеков
вложенные параметры массива created_at
Пример запроса
curl --location --globoff --request GET 'https://api.paybox.money/v5/receipts?created_at[gte]=2023-03-01&created_at[lte]=2023-03-31&offset=1&limit=2&utc=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'
Пример тела ответа
{
"data": [
{
"merchant_id": "542088",
"receipt_id": "8e6fa8d3-bf01-4a93-b453-4a018f15318d",
"operation_type": "sell",
"receipt_format": "ru_1_05",
"status": "registered",
"fiscal_document_number": "11900",
"fiscal_storage_number": "9999078900006369",
"fiscal_attribute": "790695398",
"registered_at": "30.03.202315:20:00",
"created_at": "30.03.202315:20:29",
"fiscal_provider_id": "da7d533f-b547-46ca-b127-d0b2ba6cf9f1",
"positions": [
{
"name": "Товар №1",
"quantity": 1,
"price": 100,
"measure": "piece",
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 100
},
{
"name": "Товар №2",
"quantity": 2,
"price": 50,
"measure": "piece",
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 100
}
],
"total": 200,
"settlements": [
{
"type": "cashless",
"sum": 200
}
],
"company": {
"inn": "5544332219",
"email": "customer@mail.ru",
"tax_system": "osn",
"payment_address": "shop.ru"
},
"receipt_method": "separately",
"error": null,
"link": "https://consumer.1-ofd-test.ru/v1?fn=9999078900006369&fp=790695398&i=11900&t=20230330T152000&s=7&n=1",
"payment_id": "764239789"
},
{
"merchant_id": "542088",
"receipt_id": "4e7dcdef-ccfc-485c-b63f-1f83dc66845c",
"operation_type": "sell",
"receipt_format": "ru_1_05",
"status": "registered",
"fiscal_document_number": "11552",
"fiscal_storage_number": "9999078900006286",
"fiscal_attribute": "3717461957",
"registered_at": "30.03.202315:10:00",
"created_at": "30.03.202315:12:37",
"fiscal_provider_id": "f3b26edd-a098-42c9-952c-e981a0cff900",
"positions": [
{
"name": "Товар №1",
"quantity": 1,
"price": 300,
"measure": "piece",
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 300
},
{
"name": "Товар №2",
"quantity": 3,
"price": 50,
"measure": "piece",
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 150
}
],
"total": 450,
"settlements": [
{
"type": "cashless",
"sum": 150
}
],
"company": {
"inn": "5544332219",
"email": "customer@mail.ru",
"tax_system": "osn",
"payment_address": "shop.ru"
},
"receipt_method": "separately",
"error": null,
"link": "https://consumer.1-ofd-test.ru/v1?fn=9999078900006286&fp=3717461957&i=11552&t=20230330T151000&s=7&n=1",
"payment_id": "763548541"
}
]
}
В ответ на запрос вернется список чеков с учетом отправленных фильтров. В списке будет присутствовать информация о чеках за весь период деятельности конкретного магазина, идентификатор которого был передан при генерации JWT. Список будет отсортирован повремени создания чеков в порядке убывания.
Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору.
Пример запроса
В URL необходимо передать идентификатор чека в Paybox.
Пример запроса
В URL необходимо передать идентификатор чека в Paybox.
Получение информации по чеку
curl --location --request GET 'https://api.paybox.money/v5/receipts/1a624e49-41c3-4d0f-84d3-497483e81153' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'
Пример тела ответа
В ответ на запрос придет объект чека в актуальном статусе.
В ответ на запрос придет объект чека в актуальном статусе.
{
"data": {
"merchant_id": "542088",
"receipt_id": "1a624e49-41c3-4d0f-84d3-497483e81153",
"operation_type": "sell",
"receipt_format": "ru_1_05",
"status": "registered",
"fiscal_document_number": "9322",
"fiscal_storage_number": "9999078900006369",
"fiscal_attribute": "855240058",
"registered_at": "28.03.202314:24:00",
"created_at": "28.03.202317:24:02",
"fiscal_provider_id": "509a911b-5d96-43ac-9df0-3e5d05cfc16a",
"positions": [
{
"name": "Товар №1",
"quantity": 1,
"price": 100,
"measure": "piece",
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 100
},
{
"name": "Товар №2",
"quantity": 2,
"price": 50,
"measure": "piece",
"vat_code": "vat_20",
"payment_method": "full_payment",
"payment_object": "goods",
"sum": 100
}
],
"total": 100,
"settlements": [
{
"type": "cashless",
"sum": 100
}
],
"company": {
"inn": "5544332219",
"email": "customer@mail.ru",
"tax_system": "osn",
"payment_address": "shop.ru"
},
"receipt_method": "together",
"error": null,
"link": "https://consumer.1-ofd-test.ru/v1?fn=9999078900006369&fp=855240058&i=9322&t=20230328T142400&s=7&n=1",
"payment_id": "762881172"
}
}