swag-payments/spec/paths/analytics@shops@{shopID}@refunds.yaml
2019-09-18 12:45:02 +03:00

74 lines
1.8 KiB
YAML

get:
description: Поиск возвратов
tags:
- Search
operationId: searchRefunds
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- 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: refundID
in: query
description: Идентификатор возврата
required: false
type: string
maxLength: 40
minLength: 1
- name: rrn
in: query
description: 'Retrieval Reference Number'
required: false
type: string
pattern: '^[a-zA-Z0-9]{12}$'
- name: approvalCode
in: query
description: 'Authorization Approval Code'
required: false
type: string
maxLength: 40
minLength: 1
- name: refundStatus
in: query
description: Статус возврата
type: string
enum:
- pending
- succeeded
- failed
responses:
'200':
description: Найденные возвраты
schema:
type: object
properties:
totalCount:
type: integer
result:
type: array
items:
$ref: '#/definitions/RefundSearchResult'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'