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

111 lines
2.7 KiB
YAML
Raw Normal View History

get:
description: Поиск инвойсов
tags:
- Search
operationId: searchInvoices
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- name: invoiceStatus
in: query
description: Статус инвойса для поиска
required: false
type: string
enum:
- unpaid
- cancelled
- paid
- fulfilled
- 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: invoiceID
in: query
description: Идентификатор инвойса
required: false
type: string
maxLength: 40
- name: paymentID
in: query
description: Идентификатор платежа
required: false
type: string
maxLength: 40
- 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
- name: cardNumberMask
in: query
description: Маскированый номер карты
required: false
type: string
2017-05-04 13:21:35 +00:00
pattern: '^\d{4}$'
- name: paymentAmount
in: query
description: Сумма платежа
required: false
type: integer
format: int64
minimum: 1
- name: invoiceAmount
in: query
description: Сумма инвойса
required: false
type: integer
format: int64
minimum: 1
responses:
'200':
description: Найденные инвойсы
schema:
type: object
properties:
totalCount:
type: integer
result:
type: array
items:
$ref: '#/definitions/Invoice'
'400':
$ref: '#/responses/BadRequest'
'404':
$ref: '#/responses/NotFound'