Список апелляций

Метод запроса

GET

Урл запроса

/v2/merchant/appeals

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

На вход принимаются следующие параметры

Название	Формат	Описание
transactionId	int	Фильтр по идентификатору транзакции
status	string(1-255)	Фильтр по статусу. Могут быть одно или несколько значений через запятую - PENDING, SUCCESS, DECLINE, CANCEL
pageNumber	int	Пагинация. Фильтр по номеру страницы
pageSize	int	Пагинация. Количество записей на странице
sortBy	string(1-255)	Сортировка. Поле, по которому нужно отсортировать. Пример "id" - сортирует по возрастанию идентификатора, "-id" по убыванию.

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

CURL

curl --request GET \
  --url https://{{domain}}/v2/merchant/appeals \
  --header 'Authorization: Bearer {{your_api_token}}' \
  --header 'X-Signature: {{sign}}' \
  -d 'status=SUCCESS'

PHP + GuzzleHttp

$httpClient = new \GuzzleHttp\Client();
$response = $httpClient->get('https://{{domain}}//v2/merchant/appeals', [
    'query' => [
        'status' => 'SUCCESS'
    ],
    'headers' => [
        'Authorization' => 'Bearer ' . $token,
        'X-Signature' => $sign,
    ]
]);

Параметры ответа

Название	Формат	Описание
items[].id	int	Идентификатор апелляции
items[].createdAt	string(1-255)	Дата создания апелляции
items[].status	string(1-255)	Статус апелляции (PENDING, SUCCESS, DECLINE, CANCEL)
items[].amount	decimal	Сумма апелляции
items[].transaction.id	int	Идентификатор транзакции
items[].transaction.amount	decimal	Сумма транзакции
items[].transaction.currency	string(1-255)	Код валюты ISO 4217 (RUB, UZS и т.д.)
items[].transaction.createdAt	string(1-255)	Дата создания транзакции
pageNumber	int	Номер страницы
pageSize	int	Количество записей на странице
totalCount	int	Общее количество аппеляций по выбранным фильтрам
pageCount	int	Количество страниц

Пример ответа

{
  "totalCount": 167,
  "pageCount": 167,
  "items": [
    {
      "id": 281,
      "createdAt": "2024-07-26T17:22:27.282298",
      "status": "SUCCESS",
      "amount": 1500,
      "transaction": {
        "id": 1391,
        "amount": 1500,
        "currency": "RUB",
        "createdAt": "2024-07-26T17:17:22.423825"
      }
    }
  ],
  "pageNumber": 1,
  "pageSize": 1
}