Перейти к основному содержимому

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

Метод: GET

Путь: /cp/ts/payments/list

Параметры запроса​

Параметры авторизации описаны в общем справочнике.

ПараметрТипОписание
idsuint[]Идентификаторы платежей через запятую
contractorIduintИдентификатор клиента
agreementIduintИдентификатор договора
amountStartfloatМинимальная сумма
amountEndfloatМаксимальная сумма
status[]string[]Статусы платежей; допустимые значения приведены ниже
numberstringНомер платежа
requisiteIduintИдентификатор платёжных реквизитов
skipuintКоличество записей, которое нужно пропустить
limituintМаксимальное количество записей в выборке
paymentTypestringТипы платежа через запятую; допустимые значения приведены ниже
paymentMethodIds[]uint[]Идентификаторы способов оплаты
dateStartstringНачальная дата платежа в формате RFC3339
dateEndstringКонечная дата платежа в формате RFC3339
updateDateStartstringНачальная дата поиска по времени обновления в формате RFC3339
updateDateEndstringКонечная дата поиска по времени обновления в формате RFC3339
shopLegalPersonIdsuint[]Идентификаторы юридических лиц магазина через запятую
externalIdstringПараметр для связи с внешними сервисами
fieldsstringДополнительные сведения о платеже; значения перечислены ниже

Значения fields описаны в справочнике

Допустимые статусы описаны в справочнике

Допустимые типы платежа описаны в справочнике

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

curl --get 'https://demo.public.api.abcp.ru/cp/ts/payments/list' \
--data-urlencode 'userlogin=YOUR_LOGIN' --data-urlencode 'userpsw=YOUR_PASSWORD_MD5' \
--data-urlencode 'status[]=accepted' --data-urlencode 'paymentType=customerPayment' \
--data-urlencode 'limit=30' --data-urlencode 'fields=paymentMethod,agreement'

Ответ​

Операция возвращает объект со списком платежей и количеством результатов.

ПолеОписание
listМассив объектов платежей
totalCountКоличество платежей, соответствующих фильтру

Связанные операции​