Список платежей

Swagger - подробное API платежей.

Интерфейс тела запроса на получение списка платежей:

{
   "publicKey": "string",
   "hash": "string",
   "fromId": "string", // optional
   "take": "number", // optional
   "type": "string", // optional: PAY_IN, PAY_OUT
   "status": "string", // optional: PENDING, NEED_CHECK, FAILED, SUCCESS
   "currencyCode": "string", // optional
   "createdAtFrom": "number",
   "createdAtTo": "number"
}

Таблица с описанием всех полей тела запроса:

Поле						Тип	Обязательный	Описание
publicKey						String	Да	Публичный ключ, который выдавался при регистрации мерчанта на платформе FirstPay (Ключ передается в файле, нужно передать все его содержимое).
hash						String	Да	Закодированная строка тела запроса. О том как ее сформировать - см. в разделе "Авторизация".
fromId						UUID	Нет	Id для keyset паджинации.
take						Number	Нет	Take паджинации.
type						Enum: PAY_IN, PAY_OUT	Нет	Тип платежа.
status						Enum: PENDING, NEED_CHECK, FAILED, SUCCESS	Нет	Статус платежа.
currencyCode						String	Нет	Код валюты.
createdAtFrom						Number	Да	Timestamp интервала даты создания от.
createdAtTo						Number	Да	Timestamp интервала даты создания до.

Таблица возвращаемых ответов:

code	Тело ответа	Описание
200	Платежи	При успешном запросе возвращаются данные по платежам.
400	{"error": "some text here..."}	Ошибка возникает, если не удалось распарсить тело запроса и query параметры. (скорее всего они были переданы с ошибкой).
401	{"error": "NO_LOGIN"}	Ошибка возникает, если не передали в теле запроса поле publicKey.
401	{"error": "NO_TOKEN"}	Ошибка возникает, если не передали в теле запроса поле hash.
401	{"error": "NO_KEY"}	Ошибка возникает, если передан неправильный publicKey.
401	{"error": "UNAUTHORIZED"}	Ошибка возникает, если произошла ошибка при валидации publicKey и hash.
404	{"error": "NOT_FOUND"}	Ошибка возникает, если такого платежа нет в системе.
500	{"error": "some text here..."}	Ошибка возникает, когда сервер не смог обработать запрос и произошла какая-то не штатная ситуация.

Описание полей платежей

Интерфейс платежей:

Интерфейс элемента массива payments аналогичен интерфейсу платежа.

{
  "payments": [],
  "total": "number",
  "totalSucceed": "number",
  "totalFailed": "number",
  "amounts": [
    {
      "total": "bigint",
      "currencyCode": "string"
    }
  ],
  "nextId": "string"
}

Таблица с описанием всех полей:

Поле						Тип	Описание
payments						Array	Массив платежей.
total						Number	Количество платежей.
totalSucceed						Number	Количество успешных платежей.
totalFailed						Number	Количество неуспешных платежей.
amounts						Array	Массив сумм платежей по валютам.
	total					BigInt	Сумма.
	currencyCode					String	Валюта.
nextId						String	Id для fromId keyset паджинации.