Документация · v1

Creodock API

Все операции
POSTИнтерфейс CreodockИдемпотентная команда

Создать: платежи клиентов

Безопасно создаёт платежи клиентов на основании переданного тела запроса.

OpenAPI: Save a client payment for review without affecting balance

POSThttps://api.creodock.com/api/v1/organizations/{organizationId}/finance/payments?directionId={directionId}
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
directionIdОбязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.
Idempotency-KeyОбязательно
headerstring
Уникальный ключ команды. Используйте UUID и сохраняйте тот же ключ при безопасном повторе запроса.Минимальная длина: 16 · Максимальная длина: 128

Тело запроса

Обязательно для этой операции.

application/json

Схема: CreatePaymentRequest

ПолеТипОписание
allowPossibleDuplicateНеобязательно
boolean
Поле «allowPossibleDuplicate» в структуре запроса или ответа.
amountMinorОбязательно
string
Сумма в минимальных единицах валюты.Формат: ^[0-9]+$
attachmentStoredFileIdНеобязательно
string · uuid
Поле «attachmentStoredFileId» в структуре запроса или ответа.
clientIdОбязательно
string · uuid
ID связанного клиента.
commentОбязательно
string
Поле «comment» в структуре запроса или ответа.
currencyОбязательно
string
Трёхбуквенный код валюты ISO 4217.
externalReferenceНеобязательно
string
Поле «externalReference» в структуре запроса или ответа.
invoiceIdsОбязательно
string[]
Поле «invoiceIds» в структуре запроса или ответа.
methodОбязательно
string
Поле «method» в структуре запроса или ответа.
occurredAtОбязательно
string · date-time
Поле «occurredAt» в структуре запроса или ответа.
orderIdНеобязательно
string · uuid
Поле «orderId» в структуре запроса или ответа.
scaleОбязательно
integer
Поле «scale» в структуре запроса или ответа.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

201

Pending payment

application/json

Схема: ClientPayment

ПолеТипОписание
amountОбязательно
Money
Поле «amount» в структуре запроса или ответа.
availableActionsОбязательно
FinanceAction[]
Поле «availableActions» в структуре запроса или ответа.
clientОбязательно
Option
Поле «client» в структуре запроса или ответа.
commentОбязательно
string
Поле «comment» в структуре запроса или ответа.
createdByОбязательно
Option
Поле «createdBy» в структуре запроса или ответа.
externalReferenceНеобязательно
string
Поле «externalReference» в структуре запроса или ответа.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
invoiceIdsОбязательно
string[]
Поле «invoiceIds» в структуре запроса или ответа.
methodОбязательно
string
Поле «method» в структуре запроса или ответа.
occurredAtОбязательно
string · date-time
Поле «occurredAt» в структуре запроса или ответа.
orderIdНеобязательно
string · uuid
Поле «orderId» в структуре запроса или ответа.
possibleDuplicateОбязательно
boolean
Поле «possibleDuplicate» в структуре запроса или ответа.
statusОбязательно
string
Текущий статус объекта.Допустимо: pending, confirmed, rejected, reversedПример: pending
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "amount": {
    "amountMinor": "string",
    "currency": "string",
    "scale": 0
  },
  "availableActions": [
    "create_payment"
  ],
  "client": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "comment": "string",
  "createdBy": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "externalReference": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "invoiceIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "method": "string",
  "occurredAt": "2026-09-05T12:00:00Z",
  "orderId": "00000000-0000-0000-0000-000000000000",
  "possibleDuplicate": true,
  "status": "pending",
  "version": 1
}
409

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}