История платежей

URL запроса: https://getpay.io/api/payments

Метод: GET / POST

Параметры:

secret

Секретный ключ

wallet

ID Проекта

date_start

Вывести операции от момента времени (операции, равные date_start, или более поздние). Если параметр отсутствует, выводятся все операции.

date_end

Вывести операции до момента времени (операции более ранние, чем date_end). Если параметр отсутствует, выводятся все операции.

start_record

Если параметр присутствует, то будут отображены операции, начиная с номера start_record. Операции нумеруются с 0. Подробнее про постраничный вывод списка

records

Количество запрашиваемых записей истории операций. Допустимые значения: от 1 до 100, по умолчанию — 30.

Успешный ответ в JSON формате:

{
    "next_record": 30,
    "payments": [
        {
            "paymentId":"1136051",
            "paymentKey":"3a8qf2",
            "walletId":"1",
            "paymentMethod":"mts",
            "paymentSum":"100.00",
            "paymentOutsum":"110.00",
            "paymentAccrued":"85.00",
            "paymentComm":"25.00",
            "paymentOrder":"test1",
            "paymentComment":null,
            "paymentStatus":"paid",
            "paymentDateAdd":"2021-10-01 16:02:01"
        },
        ...
    ]
}

next_record

Порядковый номер первой записи на следующей странице истории операций. Присутствует в случае наличия следующей страницы истории. Подробнее про постраничный вывод списка

payments

Список операций.

см. Параметры операции

Параметры операции:

paymentId

ID Транзакции

walletId

ID Проекта

paymentSum

Сумма платежа

paymentMethod

Метод платежа

paymentOutsum

Итоговая сумма, которую оплатил плательщик

paymentAccrued

Итоговая сумма, которая была зачислена на баланс

paymentComm

Комиссия транзакции

paymentOrder

Метка платежа, либо номер заказа внутри вашей системы

paymentComment

Комментарий платежа

paymentStatus

Статус платежа: paid - оплачено

paymentDateAdd

Дата и время создания платежа

Ответ с ошибкой:

{
    "status": "error",
    "error": "The wallet is not active!"
}

Логика отбора записей истории

Отбор записей истории осуществляется по интервалу времени.

Правила выборки данных по интервалу времени:

  1. Если заданы оба условия date_start и date_end, то отбор записей осуществляется за интервал времени равный date_start (или больше) и меньше или равно date_end.

  2. Если задано только условие date_start, осуществляется отбор всех записей со временем больше или равно date_start.

  3. Если задано только условие date_end, осуществляется отбор всех записей со временем меньше или равно date_end.

  4. Если оба условия условия date_start и date_end отсутствуют, записи выбираются без ограничения по времени.

Если история содержит большое количество операций, список операций выдается постранично. По умолчанию выдается первая страница истории. Если есть хотя бы одна последующая страница, то в ответе присутствует параметр next_record, определяющий порядковый номер ее первой записи. Чтобы получить следующую страницу, повторите запрос с теми же параметрами, добавив параметр start_record и указав в нем порядковый номер первой записи следующей страницы, полученный ранее из параметра next_record.

PreviousОбработчик платежаNextСоздание выплаты

Last updated