swag-payments/spec/paths/analytics@shops@{shopID}@payouts.yaml
2018-09-27 09:44:49 +03:00

60 lines
1.5 KiB
YAML

get:
description: Поиск выплат
tags:
- Search
operationId: searchPayouts
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- name: payoutID
in: query
description: Идентификатор выплаты
required: false
type: string
maxLength: 40
minLength: 1
- name: payoutToolType
in: query
description: Тип выплаты для поиска
required: false
type: string
enum:
- PayoutCard
- PayoutAccount
responses:
'200':
description: Найденные выплаты
schema:
type: object
properties:
totalCount:
type: integer
result:
type: array
items:
$ref: '#/definitions/Payout'
'404':
$ref: '#/responses/NotFound'
'400':
description: Неверные данные для поиска
schema:
type: object
required:
- code
- message
properties:
code:
description: |
[Код ошибки](#tag/Error-Codes)
type: string
enum:
- invalidRequest
message:
description: Человекочитаемое описание ошибки
type: string