Получение списка платежей
Метод: GET
Путь: /cp/ts/payments/list
Параметры запроса
Параметры авторизации описаны в общем справочнике.
| Параметр | Тип | Описание |
|---|---|---|
ids | uint[] | Идентификаторы платежей через запятую |
contractorId | uint | Идентификатор клиента |
agreementId | uint | Идентификатор договора |
amountStart | float | Минимальная сумма |
amountEnd | float | Максимальная сумма |
status[] | string[] | Статусы платежей; допустимые значения приведены ниже |
number | string | Номер платежа |
requisiteId | uint | Идентификатор платёжных реквизитов |
skip | uint | Количество записей, которое нужно пропустить |
limit | uint | Максимальное количество записей в выборке |
paymentType | string | Типы платежа через запятую; допустимые значения приведены ниже |
paymentMethodIds[] | uint[] | Идентификаторы способов оплаты |
dateStart | string | Начальная дата платежа в формате RFC3339 |
dateEnd | string | Конечная дата платежа в формате RFC3339 |
updateDateStart | string | Начальная дата поиска по времени обновления в формате RFC3339 |
updateDateEnd | string | Конечная дата поиска по времени обновления в формате RFC3339 |
shopLegalPersonIds | uint[] | Идентификаторы юридических лиц магазина через запятую |
externalId | string | Параметр для связи с внешними сервисами |
fields | string | Дополнительные сведения о платеже; значения перечислены ниже |
Значения fields описаны в справочнике
Допустимые статусы описаны в справочнике
Допустимые типы платежа описаны в справочнике
Пример запроса
- cURL
- JavaScript
- Go
- PHP
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'
const query = new URLSearchParams({userlogin: 'YOUR_LOGIN', userpsw: 'YOUR_PASSWORD_MD5', 'status[]': 'accepted', paymentType: 'customerPayment', limit: '30', fields: 'paymentMethod,agreement'});
const response = await fetch(`https://demo.public.api.abcp.ru/cp/ts/payments/list?${query}`);
console.log(await response.json());
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
query := url.Values{"userlogin": {"YOUR_LOGIN"}, "userpsw": {"YOUR_PASSWORD_MD5"}, "status[]": {"accepted"}, "paymentType": {"customerPayment"}, "limit": {"30"}, "fields": {"paymentMethod,agreement"}}
response, err := http.Get("https://demo.public.api.abcp.ru/cp/ts/payments/list?" + query.Encode())
if err != nil { panic(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
fmt.Println(string(body))
}
<?php
$params = ['userlogin' => 'YOUR_LOGIN', 'userpsw' => 'YOUR_PASSWORD_MD5', 'status[]' => 'accepted', 'paymentType' => 'customerPayment', 'limit' => '30', 'fields' => 'paymentMethod,agreement'];
$ch = curl_init('https://demo.public.api.abcp.ru/cp/ts/payments/list?' . http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);
Ответ
Операция возвращает объект со списком платежей и количеством результатов.
| Поле | Описание |
|---|---|
list | Массив объектов платежей |
totalCount | Количество платежей, соответствующих фильтру |