swag-payments/spec/paths/analytics@shops@{shopID}@payments.yaml

155 lines
4.0 KiB
YAML
Raw Normal View History

get:
description: Поиск платежей
tags:
- Search
operationId: searchPayments
parameters:
- $ref: '#/parameters/requestID'
2018-09-27 06:44:49 +00:00
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/limit'
- name: paymentStatus
in: query
description: Статус платежа для поиска
required: false
type: string
enum:
- pending
- processed
- captured
- cancelled
2017-09-18 16:20:46 +00:00
- refunded
- failed
- name: paymentFlow
in: query
description: Flow платежа
required: false
type: string
enum:
- instant
- hold
- name: paymentMethod
in: query
description: Метод оплаты
required: false
type: string
enum:
- bankCard
- paymentTerminal
- name: paymentTerminalProvider
in: query
description: Провайдер платежного терминала
required: false
type: string
enum:
- euroset
- name: invoiceID
in: query
description: Идентификатор инвойса
required: false
type: string
maxLength: 40
minLength: 1
- name: paymentID
in: query
description: Идентификатор платежа
required: false
type: string
maxLength: 40
minLength: 1
- name: payerEmail
in: query
description: 'Email, указанный при оплате'
required: false
type: string
format: email
maxLength: 100
- name: payerIP
in: query
description: IP-адрес плательщика
required: false
type: string
format: ip-address
maxLength: 45
- name: payerFingerprint
in: query
description: Уникальный отпечаток user agent'а плательщика
required: false
type: string
maxLength: 1000
2017-10-23 13:26:44 +00:00
- name: customerID
in: query
description: Идентификатор плательщика
required: false
type: string
maxLength: 40
minLength: 1
- name: bin
in: query
description: BIN банка-эмитента карты
required: false
type: string
pattern: '^\d{6,8}$'
- name: lastDigits
in: query
description: Последние цифры номера карты
required: false
type: string
pattern: '^\d{2,4}$'
- name: rrn
in: query
description: 'Retrieval Reference Number'
required: false
type: string
pattern: '^\d{12}$'
- name: approval_code
in: query
description: 'Authorization Approval Code'
required: false
type: string
maxLength: 40
minLength: 1
- x-rebillyMerge:
- name: bankCardTokenProvider
in: query
required: false
- $ref: '#/definitions/BankCardTokenProvider'
- x-rebillyMerge:
- name: bankCardPaymentSystem
in: query
required: false
- $ref: '#/definitions/BankCardPaymentSystem'
- name: paymentAmount
in: query
description: Сумма платежа
required: false
type: integer
format: int64
minimum: 1
- x-rebillyMerge:
- name: continuationToken
in: query
required: false
- $ref: '#/definitions/ContinuationToken'
responses:
'200':
description: Найденные платежи
schema:
type: object
properties:
continuationToken:
x-rebillyMerge:
- $ref: '#/definitions/ContinuationToken'
result:
type: array
items:
$ref: '#/definitions/PaymentSearchResult'
'404':
$ref: '#/responses/NotFound'
2018-10-22 07:08:37 +00:00
'401':
$ref: '#/responses/Unauthorized'
'400':
2018-10-22 11:43:35 +00:00
$ref: '#/responses/DefaultLogicError'