Skip to main content

Получить список транзакций банковского терминала

GET 
/v5/orgs/:org_guid/terminals/bank/:terminal_guid/transactions

Коды возможных ошибок:​

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию

Важная информация!​

Поиск по списку производится по полям: "reference_retrieval_number", "amount", "cardholder_name", "card_number".

Request​

Path Parameters

    org_guid uuidrequired

    Уникальный идентификатор организации

    terminal_guid anyrequired

    Уникальный идентификатор банковского терминала

Query Parameters

    created_from date-time

    Создание объекта произошло позже чем указанные дата и время (включая эти дату и время)

    created_to date-time

    Создание объекта произошло раньше чем указанные дата и время

    updated_from date-time

    Последнее изменение объекта произошло позже чем указанные дата и время (включая эти дату и время)

    updated_to date-time

    Последнее изменение объекта произошло раньше чем указанные дата и время

    query string

    Possible values: non-empty and <= 64 characters

    Поиск производится по полям: merchant_id, term_id, authorized_amount, authorization_code, aid, rrn, card_holder, card_number, meta, metadata

    order_by TransactionOrderings

    Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, operation_asc, operation_desc, registered_at_asc, registered_at_desc]

    Вариант сортировки результатов запроса

    page_token string

    Токен (курсор, ссылка) запрашиваемой страницы результатов списка. Если он не задан, то возвращается первая страница результатов. Размер страницы списка регулируется сервером.

    selection SelectionModes

    Possible values: [alive_only, archived_only, all]

    Режим выборки объектов из списка

    presentation PresentationModes

    Possible values: [compact, full]

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

    operation TransactionOperationTypes[]

    Possible values: [Payment, Cancellation, Refund]

    Перечисление типов операций терминала, которые должны быть возвращены

    registered_at_from date-time

    Фильтр: Транзакция зарегистрирована после этой даты (включительно)

    registered_at_to date-time

    Фильтр: Транзакция зарегистрирована до этой даты (включительно)

    amount_from int64

    Фильтр: Сумма транзакции больше или равна указанному значению

    amount_to int64

    Фильтр: Сумма транзакции меньше или равна указанному значению. Если указанное значение сопадает с LifePay.Api.Public.Models.QueryParameters.Filters.TransactionFilters.amount_from то возвращаются транзакции суммой транзакции совпадающей с этими двумя значениями

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: c4396124-fa4f-4860-99d2-f5aad4859b2f
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Responses​

Success

Schema

    items

    object[]

    nullable

    Список лементов типа <typeparamref name="T" />

  • Array [

    • authorization_code stringnullable

    Possible values: <= 16 characters

    Код авторизации

    reference_retrieval_number stringnullable

    Possible values: <= 24 characters

    Уникальный номер операции (RRN, Reference Retrieval Number)

    emv_application_label stringnullable

    Possible values: <= 48 characters

    Лэйбл приложения EMV

    card_number stringnullable

    Possible values: <= 19 characters

    Номер карты (Primary account number, PAN)

    cardholder_name stringnullable

    Possible values: <= 32 characters

    Имя, Фамилия держателя карты

    sources

    object

    Базовые поля банковской транзакции

    operation PTEOperations (string)

    Possible values: [Payment, Cancellation, Refund, Rollback]

    Типы операций

    merchant_id stringnullable

    Possible values: <= 24 characters

    Идентификатор продавца

    terminal_id stringnullable

    Possible values: <= 24 characters

    Идентификатор терминала

    number int32

    Номер чека

    amount int32

    Сумма операции

    currency_code CurrencyCodes (string)

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    Коды валют (ISO 4217)

    registered_at date-time

    Дата и время совершения операции

    authorization_code stringnullable

    Possible values: <= 16 characters

    Код авторизации

    reference_retrieval_number stringnullable

    Possible values: <= 24 characters

    Уникальный номер операции (RRN, Reference Retrieval Number)

    emv_application_identifier stringnullable

    Possible values: <= 24 characters

    Идентификатор приложения EMV (EMV Application Identifier, AID)

    emv_application_label stringnullable

    Possible values: <= 48 characters

    Лэйбл приложения EMV

    card_number stringnullable

    Possible values: <= 19 characters

    Номер карты (Primary account number, PAN)

    cardholder_name stringnullable

    Possible values: <= 32 characters

    Имя, Фамилия держателя карты

    card_expires_at date-timenullable

    Дата окончания срока действия карты

    card_hash stringnullable

    Possible values: <= 256 characters

    Хэш данных карты

    host_response_code stringnullable

    Possible values: <= 8 characters

    Код ответа хоста

    host_response_message stringnullable

    Possible values: <= 128 characters

    Текст ответа хоста

    print_view stringnullable

    Готовый образ чека для печати

    additional_attributes

    object[]

    nullable

    Дополнительные атрибуты

  • Array [

    • name stringnullable

    Possible values: <= 128 characters

    Наименование

    value stringnullable

    Possible values: <= 1024 characters

    Значение

    type_of stringnullable

    Тип объекта

  • ]

    • type_of stringnullable

    Тип объекта

    bank_terminal

    object

    required

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    type_of stringnullable

    Тип объекта

    amount

    object

    required

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    Коды валют (ISO 4217)

    type_of stringnullable

    Тип объекта

    registered_at date-timerequired

    Дата и время совершения операции

    operation TransactionOperationTypes (string)required

    Possible values: [Payment, Cancellation, Refund]

    Типы транзакционных операций

    created_at date-time

    Дата создания

    updated_at date-time

    Дата последнего обновления

    deleted_at date-timenullable

    Дата удаления (архивации)

    meta stringnullable

    Possible values: <= 128 characters

    Метаданные объекта (нарпимер, идентификатор в сторонней системе)

    meta_data

    object

    nullable

    Метаданные объекта в формате ключ-значение

    property name* string
    guid uuid

    Глобальный уникальный идентификатор объекта

  • ]

    • next_page_token stringnullable

    Токен следующей страницы результатов списка

    page_number int32

    Номер текущей страницы. Если нумерация страниц не поддерживается, принимает значение -1 либо отсутствует. В остальных случаях принимает значения от 1 до total_pages включительно.

    pages_total int32

    общее кол-во страниц (>= 0)

    items_per_page int32

    кол-во элементов на странице (постоянное значение с сервера)

    items_total int32

    общее кол-во элементов списка

    type_of stringnullable

    Тип объекта

Loading...