swag-analytics/spec/definitions/Payout.yaml
ndiezel0 6d5fae7dce
CAPI-381: Port SWAG CAPI V3 to SWAG Analytics API (#1)
* CAPI-381: Port SWAG CAPI V3 to SWAG YAPI

* CAPI-381: Clean up unused definitions

* CAPI-381: Rename YAPI to Dashboard API

* CAPI-381: Remove wsd folder and review fixes

* Update spec/definitions/ContinuationToken.yaml

Co-Authored-By: Andrew Mayorov <a.mayorov@rbkmoney.com>

* CAPI-381: Update rebillyMerge script

* CAPI-381: Change copyright and remove wercker deploy

* CAPI-381: Fix `npm start`

* CAPI-381: Remove ExternalIDConflictError

* CAPI-381: Change error message example to one that can actually occur

* CAPI-381: Remove redundant error description

* CAPI-381: Rename x-rebillyMerge to x-merge-properties

* CAPI-381: Rename dashboard api to analytics api

* CAPI-381: Return copyright

* CAPI-381: Review fix

* CAPI-381: Remove ReadOnly fields

* CAPI-381: Remove `analytics` from paths

* CAPI-381: Correct API description
2019-09-06 17:43:30 +03:00

57 lines
1.8 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

type: object
required:
- id
- shopID
- createdAt
- amount
- currency
- payoutToolDetails
properties:
id:
description: Идентификатор выплаты
type: string
shopID:
description: Идентификатор магазина
type: string
createdAt:
description: Дата и время создания
type: string
format: date-time
cancellationDetails:
description: Детали отмены выплаты
type: string
maxLength: 1000
amount:
description: |
Сумма выплаты в минорных денежных
единицах, например в копейках в случае указания российских рублей в
качестве валюты.
type: integer
format: int64
minimum: 1
fee:
description: 'Комиссия системы, в минорных денежных единицах'
type: integer
format: int64
minimum: 0
currency:
x-merge-properties:
- $ref: '#/definitions/Currency'
payoutToolDetails:
$ref: '#/definitions/PayoutToolDetails'
payoutSummary:
description: Описание части суммы вывода, сгруппированное по типу операций над денежными средствами
type: array
items:
$ref: '#/definitions/PayoutSummaryItem'
status:
description: Статус выплаты
type: string
metadata:
description: |
Произвольный, специфичный для клиента API и непрозрачный для системы набор данных,
ассоциированных с данной выплатой
type: object
example:
payoutDesc: Custom payout