Package dev.vality.anapi.v2.api

Interface PaymentsApiDelegate

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2023-07-07T08:12:11.951968249Z[Etc/UTC]")
public interface PaymentsApiDelegate

A delegate to be called by the PaymentsApiController}. Implement this interface with a Service annotated class.

Method Summary

Modifier and Type	Method	Description
default Optional<org.springframework.web.context.request.NativeWebRequest>	getRequest()
default org.springframework.http.ResponseEntity<InlineResponse2009>	searchPayments(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm, String invoiceID, List<String> invoiceIDs, String paymentID, String paymentStatus, String paymentFlow, String paymentMethod, String paymentTerminalProvider, String payerEmail, String payerIP, String payerFingerprint, String customerID, String first6, String last4, String rrn, String approvalCode, String bankCardTokenProvider, String bankCardPaymentSystem, Long paymentAmountFrom, Long paymentAmountTo, String externalID, String continuationToken)	GET /payments : Поиск платежей Поиск платежей

Method Details

getRequest

default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()

searchPayments

default org.springframework.http.ResponseEntity<InlineResponse2009> searchPayments(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
Integer limit,
String xRequestDeadline,
String shopID,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm,
String invoiceID,
List<String> invoiceIDs,
String paymentID,
String paymentStatus,
String paymentFlow,
String paymentMethod,
String paymentTerminalProvider,
String payerEmail,
String payerIP,
String payerFingerprint,
String customerID,
String first6,
String last4,
String rrn,
String approvalCode,
String bankCardTokenProvider,
String bankCardPaymentSystem,
Long paymentAmountFrom,
Long paymentAmountTo,
String externalID,
String continuationToken)

GET /payments : Поиск платежей Поиск платежей

Parameters:

xRequestID - Уникальный идентификатор запроса к системе (required)

partyID - Уникальный идентификатор участника в рамках платформы (required)

fromTime - Начало временного отрезка (required)

toTime - Конец временного отрезка (required)

limit - Лимит выборки (required)

xRequestDeadline - Максимальное время обработки запроса (optional)

shopID - Идентификатор магазина (optional)

shopIDs - Идентификаторы магазинов (optional)

excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)

paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)

invoiceID - Идентификатор инвойса (optional)

invoiceIDs - Список инвойсов (optional)

paymentID - Идентификатор платежа в рамках инвойса (optional)

paymentStatus - Статус платежа для поиска (optional)

paymentFlow - Flow платежа (optional)

paymentMethod - Метод оплаты (optional)

paymentTerminalProvider - Провайдер платежного терминала (optional)

payerEmail - Email, указанный при оплате (optional)

payerIP - IP-адрес плательщика (optional)

payerFingerprint - Уникальный отпечаток user agent'а плательщика (optional)

customerID - Идентификатор плательщика (optional)

first6 - Первые 6 цифр номера карты (optional)

last4 - Последние 4 цифры номера карты (optional)

rrn - Retrieval Reference Number (optional)

approvalCode - Authorization Approval Code (optional)

bankCardTokenProvider - (optional)

bankCardPaymentSystem - (optional)

paymentAmountFrom - Минимальная сумма платежа (optional)

paymentAmountTo - Максимальная сумма платежа (optional)

externalID - Внешний идентификатор (optional)

continuationToken - (optional)

Returns:

Найденные платежи (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)

See Also:

PaymentsApi.searchPayments(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.Integer, java.lang.String, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String, java.lang.String, java.util.List<java.lang.String>, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Long, java.lang.Long, java.lang.String, java.lang.String)