Список выплат по расчётным периодам

POST /v1/finance/payout/list

POST/v1/finance/payout/list

Тело запроса

filter

object

Параметры фильтрации.

Показать свойства

date_from

string

Начало периода (RFC3339).

date_to

string

Окончание периода (RFC3339).

status

array

Фильтр по статусам выплат.

Допустимые значения

PENDINGPAID

cursor

string

Курсор постраничной выборки.

limit

integer

Размер страницы. min = 1; max = 300; default = 100.

Успешный ответ

200A successful response.

application/json

object

payouts

array

Список выплат.

financeFboPayout

Показать свойства

financeFboPayout

payout_id

string

Идентификатор выплаты.

status

string

Статус выплаты.

Допустимые значения

PENDINGPAID

amount

integer

Сумма выплаты, умноженная на 100.

currency

string

Валюта выплаты.

Допустимые значения

RUBBYNKZTEURUSDCNY

period_from

string

Начало периода (RFC3339).

period_to

string

Окончание периода (RFC3339).

paid_at

string

Время выплаты (RFC3339).

next_cursor

string

Курсор следующей страницы.

Ошибки

400Некорректный запрос

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки.

OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

401Ошибка авторизации

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки.

OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

429Превышен лимит запросов

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки.

OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

500Внутренняя ошибка сервера

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки.

OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

defaultОшибка (неожиданная или прочие)

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки.

OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

POST/v1/finance/payout/list

1curl https://api.omninet.ru/v1/finance/payout/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "date_from": "string",7    "date_to": "string",8    "status": [9      "string"10    ]11  },12  "cursor": "string",13  "limit": 014}'

{
  "payouts": [
    {
      "payout_id": "string",
      "status": "string",
      "amount": 0,
      "currency": "RUB",
      "period_from": "string",
      "period_to": "string",
      "paid_at": "string"
    }
  ],
  "next_cursor": "string"
}

A successful response.