Package dev.vality.anapi.v2.api

Interface PaymentsApi

All Known Implementing Classes:

PaymentsApiController

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

Method Summary

Modifier and Type	Method	Description
default PaymentsApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<InlineResponse2009>	searchPayments(String xRequestID, @NotNull @Size(min=1,max=40) @Valid String partyID, @NotNull @Valid OffsetDateTime fromTime, @NotNull @Valid OffsetDateTime toTime, @NotNull @Min(1L) @Max(1000L) @Valid Integer limit, String xRequestDeadline, @Size(min=1,max=40) @Valid String shopID, @Valid List<String> shopIDs, @Valid List<String> excludeShopIDs, @Valid String paymentInstitutionRealm, @Size(min=1,max=40) @Valid String invoiceID, @Valid List<String> invoiceIDs, @Size(min=1,max=40) @Valid String paymentID, @Valid String paymentStatus, @Valid String paymentFlow, @Valid String paymentMethod, @Valid String paymentTerminalProvider, @Size(max=100) @Email @Valid String payerEmail, @Size(max=45) @Valid String payerIP, @Size(max=1000) @Valid String payerFingerprint, @Size(min=1,max=40) @Valid String customerID, @Pattern(regexp="^\\d{6}$") @Valid String first6, @Pattern(regexp="^\\d{4}$") @Valid String last4, @Pattern(regexp="^[a-zA-Z0-9]{12}$") @Valid String rrn, @Size(min=1,max=40) @Valid String approvalCode, @Valid String bankCardTokenProvider, @Valid String bankCardPaymentSystem, @Min(1L) @Valid Long paymentAmountFrom, @Min(1L) @Valid Long paymentAmountTo, @Size(min=1,max=40) @Valid String externalID, @Valid String continuationToken)	GET /payments : Поиск платежей Поиск платежей

Method Details

getDelegate

default PaymentsApiDelegate getDelegate()

searchPayments

@RequestMapping(method=GET,
                value="/payments",
                produces="application/json; charset=utf-8")
default org.springframework.http.ResponseEntity<InlineResponse2009> searchPayments(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@NotNull @Size(min=1,max=40) @Valid @RequestParam(value="partyID",required=true)
@NotNull @Size(min=1,max=40) @Valid String partyID,
@NotNull @Valid @RequestParam(value="fromTime",required=true) @DateTimeFormat(iso=DATE_TIME)
@NotNull @Valid OffsetDateTime fromTime,
@NotNull @Valid @RequestParam(value="toTime",required=true) @DateTimeFormat(iso=DATE_TIME)
@NotNull @Valid OffsetDateTime toTime,
@NotNull @Min(1L) @Max(1000L) @Valid @RequestParam(value="limit",required=true)
@NotNull @Min(1L) @Max(1000L) @Valid Integer limit,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@Size(min=1,max=40) @Valid @RequestParam(value="shopID",required=false)
@Size(min=1,max=40) @Valid String shopID,
@Valid @RequestParam(value="shopIDs",required=false)
@Valid List<String> shopIDs,
@Valid @RequestParam(value="excludeShopIDs",required=false)
@Valid List<String> excludeShopIDs,
@Valid @RequestParam(value="paymentInstitutionRealm",required=false)
@Valid String paymentInstitutionRealm,
@Size(min=1,max=40) @Valid @RequestParam(value="invoiceID",required=false)
@Size(min=1,max=40) @Valid String invoiceID,
@Valid @RequestParam(value="invoiceIDs",required=false)
@Valid List<String> invoiceIDs,
@Size(min=1,max=40) @Valid @RequestParam(value="paymentID",required=false)
@Size(min=1,max=40) @Valid String paymentID,
@Valid @RequestParam(value="paymentStatus",required=false)
@Valid String paymentStatus,
@Valid @RequestParam(value="paymentFlow",required=false)
@Valid String paymentFlow,
@Valid @RequestParam(value="paymentMethod",required=false)
@Valid String paymentMethod,
@Valid @RequestParam(value="paymentTerminalProvider",required=false)
@Valid String paymentTerminalProvider,
@Size(max=100) @Email @Valid @RequestParam(value="payerEmail",required=false)
@Size(max=100) @Email @Valid String payerEmail,
@Size(max=45) @Valid @RequestParam(value="payerIP",required=false)
@Size(max=45) @Valid String payerIP,
@Size(max=1000) @Valid @RequestParam(value="payerFingerprint",required=false)
@Size(max=1000) @Valid String payerFingerprint,
@Size(min=1,max=40) @Valid @RequestParam(value="customerID",required=false)
@Size(min=1,max=40) @Valid String customerID,
@Pattern(regexp="^\\d{6}$") @Valid @RequestParam(value="first6",required=false)
@Pattern(regexp="^\\d{6}$") @Valid String first6,
@Pattern(regexp="^\\d{4}$") @Valid @RequestParam(value="last4",required=false)
@Pattern(regexp="^\\d{4}$") @Valid String last4,
@Pattern(regexp="^[a-zA-Z0-9]{12}$") @Valid @RequestParam(value="rrn",required=false)
@Pattern(regexp="^[a-zA-Z0-9]{12}$") @Valid String rrn,
@Size(min=1,max=40) @Valid @RequestParam(value="approvalCode",required=false)
@Size(min=1,max=40) @Valid String approvalCode,
@Valid @RequestParam(value="bankCardTokenProvider",required=false)
@Valid String bankCardTokenProvider,
@Valid @RequestParam(value="bankCardPaymentSystem",required=false)
@Valid String bankCardPaymentSystem,
@Min(1L) @Valid @RequestParam(value="paymentAmountFrom",required=false)
@Min(1L) @Valid Long paymentAmountFrom,
@Min(1L) @Valid @RequestParam(value="paymentAmountTo",required=false)
@Min(1L) @Valid Long paymentAmountTo,
@Size(min=1,max=40) @Valid @RequestParam(value="externalID",required=false)
@Size(min=1,max=40) @Valid String externalID,
@Valid @RequestParam(value="continuationToken",required=false)
@Valid 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)