Информация о реестрах наложенных платежей
Метод предназначен для получения информации о реестрах наложенных платежей, по которым клиенту был переведен наложенный платеж в заданную клиентом дату.
Запрос на получение информации о реестрах наложенных платежей
Для использования необходимо отправить GET-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/registries |
боевая | https://api.cdek.ru/v2/registries |
Параметры запроса
Поддерживаются следующие параметры:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | date | Дата, за которую необходимо вернуть реестры наложенных платежей, по которым был переведен наложенный платеж | date | да |
Ответ на получение информации о реестрах наложенных платежей
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | registries | Список реестров наложенных платежей, которые были оплачены | [ ] | нет |
1.1 | registry_number | Номер реестра наложенного платежа | integer | да |
1.2 | payment_date | Фактическая дата оплаты реестра наложенного платежа | date | нет |
1.3 | sum | Сумма по реестру (в валюте взаиморасчетов) | float | да |
1.4 | payment_order_number | Номер платежного поручения, в рамках которого был осуществлен платеж Если атрибут отсутствует в ответе или пустой, то для уточнения причин, пожалуйста, свяжитесь со своим менеджером | string | нет |
1.5 | orders | Список заказов | [ ] | да |
1.5.1 | cdek_number | Номер заказа в ИС СДЭК | string | да |
1.5.2 | transfer_sum | Сумма к начислению (в валюте взаиморасчетов) | float | да |
1.5.3 | payment_sum | Сумма наложенного платежа, которую взяли с получателя (в валюте взаиморасчетов) | float | да |
1.5.4 | total_sum_without_agent | Итоговая стоимость заказа без учета агентского вознаграждения (в валюте взаиморасчетов) | float | да |
1.5.5 | agent_commission_sum | Агентское вознаграждение по переводу наложенного платежа (в валюте взаиморасчетов) | float | да |
2 | errors | Список ошибок | [ ] | нет |
2.1 | code | Код ошибки | string() | да |
2.2 | message | Описание ошибки | string() | да |
https://api.cdek.ru/v2/registries?date=2022-05-21' |
{ "registries": [ { "registry_number": 7100000, "payment_date": "2022-05-21", "sum": 8554.00, "orders": [ { "cdek_number": "1300000000", "transfer_sum": 7358.00, "payment_sum": 7358.00, "total_sum_without_agent": 182.07, "agent_commission_sum": 132.44 }, { "cdek_number": "130000001", "transfer_sum": 1196.00, "payment_sum": 1196.00, "total_sum_without_agent": 577.44, "agent_commission_sum": 21.53 } ] } ] } |
© 2000—2023, Курьерская компания СДЭК