Статус жалобы

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

Интерфейс тела запроса на проверку статуса жалобы:

{
   "publicKey": "string",
   "hash": "string",
   "id": "string", // optional
   "paymentId": "string", // optional
   "merchantPaymentId": "string" // optional
}

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

Поле						Тип	Обязательный	Описание
publicKey						String	Да	Публичный ключ, который выдавался при регистрации мерчанта на платформе FirstPay (Ключ передается в файле, нужно передать все его содержимое).
hash						String	Да	Закодированная строка тела запроса. О том как ее сформировать - см. в разделе "Авторизация".
id						String	По ситуации	Id платежа в системе FirstPay. В запросе должен быть передан либо id, либо paymentId, либо merchantPaymentId. Если указаны несколько полей, то сервер сначала проверяет наличие жалобы по id, потом по paymentId, а уже потом по merchantPaymentId.
paymentId						String	По ситуации	Id платежа в системе FirstPay.
merchantPaymentId						String	По ситуации	Id платежа в системе мерчанта, который был указан в поле merchantPaymentId при создании платежа.

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

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..."}	Ошибка возникает, когда сервер не смог обработать запрос и произошла какая-то не штатная ситуация.

Описание полей жалобы

Интерфейс жалобы:

{
    "id": "string",
    "merchantPaymentId": "string",
    "merchantUserId": "string", // optional
    "paymentMethodId": "string",   
    "currencyCode": "string",
    "paymentId": "string", // optional
    "status": "string",
    "amount": 0, // optional
    "comment": "string", // optional
    "createdAt": "string",
    "updatedAt": "string"
}

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

Поле						Тип	Описание
id						String	ID платежа.
merchantPaymentId						String	Равен указанному merchantPaymentId при создании платежа.
merchantUserId						String	Опциональное поле. Равен указанному merchantUserId при создании платежа.
paymentMethodId						String	ID платежного метода.
currencyCode						Enum	ISO код валюты: USD, INR, BDT, PKR и тд.
paymentId						String	Опциональное поле. ID платежа в системе FirstPay.
status						Enum	Статус жалобы: PENDING, NEED_CHECK, APPROVED, DECLINED, COMPLETED.
amount						Number	Опциональное поле. Сумма в указанной валюте.
comment						String	Опциональное поле. Дополнительный комментарий.
createdAt						string	Дата создания жалобы.
updatedAt						string	Дата изменения жалобы.