API docs by Redocly

DW-Dynamics API Documentation (2.2.x)

Download OpenAPI specification:

API Support Team: support@dw-dynamics.com

Welcome to the API documentation page for the DW-Dynamics platform.

Customers

Текущий клиент

Текущий клиент устанавливается в контексте безопасности и может быть изменен, если есть несколько доступных клиентов.

Authorizations:
Customers_API_Authorization

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "state": "New",
  • "name": "string",
  • "type": "Individual",
  • "kind": "string",
  • "compliance_state": "Restricted",
  • "business_code": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "state_changed": "2019-08-24T14:15:22Z",
  • "externals": [
    ]
}

Список клиентов

Возвращает список доступных клиентов. При наличии параметра "q" работает в режиме поиска и фильтрации клиентов.

  • q - ищет указанную подстроку в наименовании клиента, анкетных его данных, паспортных, а также в адресах электронной почты и номерах телефона. Можно указывать идентификатор объекта, номер счета.
  • types - список типов клиентов, которые нужно фильтровать: Individual (физические лица), Soleproprietorship (индивидуальные предприниматели) и Organization (организации).
  • compliance_states - фильтрация по статусам идентификации (например, Passed, Restricted).
  • states - фильтрация по статусам (например, Active или Inactive).
  • external_id - в случае, если не указан параметр q, то выполняет поиск строго по внешнему идентификатору клиента/счета/пользователя (при наличии такой связи с внешней системой).
  • external_type - тип внешнего идентификатора, применяемый вместе с external_id - допустимые значения: Customer, User, Account.
  • contact - в случае, если не указан параметр q или external_id, то выполняет поиск строго контакту - номеру телефона или email'у.
  • tax_id - поиск по ИНН.
  • registration_number - поиск по регистрационному номеру юридического лица (или номеру идентификационного документа физического лиц).

Обращаем внимание, что поиск более эффективен, если в параметрах states, types или compliance_states указано строго по одному значению. Например, 

/v1/customers?external_id=XYZ&states=Active&types=Organization&compliance_states=Passed
Authorizations:
Customers_API_Authorization
query Parameters
q
string

Поисковый запрос

types
Array of arrays
Items Enum: "Organization" "Individual" "Soleproprietopship"

Список типов

compliance_states
Array of arrays
Items Enum: "Passed" "Restricted"

Список статусов идентификации

states
string
Enum: "Active" "Inactive"

Список статусов

external_id
string

Идентификатор клиента/счета/пользователя во внешней системе

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Информация о клиенте по ID

Authorizations:
Customers_API_Authorization
path Parameters
id
required
string

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "state": "New",
  • "name": "string",
  • "type": "Individual",
  • "kind": "string",
  • "compliance_state": "Restricted",
  • "business_code": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "state_changed": "2019-08-24T14:15:22Z",
  • "externals": [
    ]
}

Смена текущего клиента

Authorizations:
Customers_API_Authorization
path Parameters
id
required
string

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "state": "New",
  • "name": "string",
  • "type": "Individual",
  • "kind": "string",
  • "compliance_state": "Restricted",
  • "business_code": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "state_changed": "2019-08-24T14:15:22Z",
  • "externals": [
    ]
}

Список групп

Получение списка групп, которые ассоциированы с данным клиентом.

id - идентификатор клиента.

Authorizations:
Customers_API_Authorization
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Contacts

Список контактов

Возвращает список контактов текущего клиента.

Authorizations:
Contacts_Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Создание контакта

Создает новый контакт заданного типа. При создании контакта происходит автоматическая отправка кода подтверждения на него.

В случае Phone приходит SMS-сообщение с кодиком, который нужно будет указать в endpoint для подтверждения (см. /confirm/contact/{id}).

В случае Email на адрес электронной почты приходит ссылка, после перехода на которую электронная почта будет подтверждена.

Authorizations:
Contacts_Authorization
Request Body schema: application/json
kind
string
Enum: "Main" "Other"

Вид контакта: Main (основной) и Other(прочий).

type
string
Enum: "Phone" "Email"

Тип контакта: Phone (мобильный номер) и Email (электронная почта).

value
string

Значение контакта, т.е. номер телефона или адрес почты.

id
number

ID записи

Responses

Request samples

Content type
application/json
{
  • "kind": "Main",
  • "type": "Phone",
  • "value": "79122437136 или alex@mail.com",
  • "id": 0
}

Response samples

Content type
application/json
{
  • "kind": "Main",
  • "type": "Phone",
  • "value": "79122437136 или alex@mail.com",
  • "id": 0,
  • "state": "New"
}

Подтверждение телефона

Подтверждение телефонного номера путем ввода одноразового кодика, который был на него отправлен.

Authorizations:
Contacts_Authorization
path Parameters
id
required
string
Request Body schema: application/json
kind
string
Enum: "Main" "Other"

Вид контакта: Main (основной) и Other(прочий).

type
string
Enum: "Phone" "Email"

Тип контакта: Phone (мобильный номер) и Email (электронная почта).

value
string

Значение контакта, т.е. номер телефона или адрес почты.

id
number

ID записи

otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Responses

Request samples

Content type
application/json
{
  • "kind": "Main",
  • "type": "Phone",
  • "value": "79122437136 или alex@mail.com",
  • "id": 0,
  • "otp": "0323",
  • "confirm_channel": "SMS"
}

Response samples

Content type
application/json
{
  • "kind": "Main",
  • "type": "Phone",
  • "value": "79122437136 или alex@mail.com",
  • "id": 0,
  • "state": "New"
}

Удаление контакта

Удаляет заданный контакт. Пользоваться функцией нужно осторожно, поскольку она позволяет удалить в том числе единственный телефон, который используется для входа/подтверждения.

path Parameters
id
required
string

Responses

Основной контакт

Установка данного контакта в качестве основого (kind = 'Main').

Основной контакт используется как основной канал коммуникации:

  • основной телефон - используется для отправки одноразовых паролей (OTP)
  • основной email - используется в качестве основого канала доставки уведомлений.

Установка основого телефона/email должна сопровождаться подтверждением, которое выполняется путем отправки одноразового кодика на текущий основной номер телефона. Одноразовый кодик используется в endpoint подтверждения (см. /confirm/contact/main/{id}).

Если по каким-то причинам нет основного номера телефона, то контакт сразу же переходит в Main

Authorizations:
Contacts_Authorization
path Parameters
id
required
string
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "kind": "Main",
  • "type": "Phone",
  • "value": "79122437136 или alex@mail.com",
  • "id": 0,
  • "state": "New",
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS"
}

Подтверждение основного телефона

Подтверждает операцию установки заданного контакта в качестве основного (kind = 'Main').

Authorizations:
Contacts_Authorization
path Parameters
id
required
string

ID контакта

Request Body schema: application/json
kind
string
Enum: "Main" "Other"

Вид контакта: Main (основной) и Other(прочий).

type
string
Enum: "Phone" "Email"

Тип контакта: Phone (мобильный номер) и Email (электронная почта).

value
string

Значение контакта, т.е. номер телефона или адрес почты.

id
number

ID записи

otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Responses

Request samples

Content type
application/json
{
  • "kind": "Main",
  • "type": "Phone",
  • "value": "79122437136 или alex@mail.com",
  • "id": 0,
  • "otp": "0323",
  • "confirm_channel": "SMS"
}

Response samples

Content type
application/json
{
  • "kind": "Main",
  • "type": "Phone",
  • "value": "79122437136 или alex@mail.com",
  • "id": 0,
  • "state": "New"
}

CustomerData

Данные юр. лица по ID Deprecated

Возвращает анкетные данные клиента юридического лица

Authorizations:
Corporate_Data_API_Authorization
path Parameters
id
required
integer
Example: 12345

ID клиента

Responses

Response samples

Content type
application/json
No sample

Данные юр. лица по ID

Возвращает анкетные данные клиента юридического лица, но с ограниченным числом распорядителей (affiliates) равным не более 5.

Authorizations:
Corporate_Data_API_Authorization
path Parameters
id
required
integer
Example: 12345

ID клиента

Responses

Response samples

Content type
application/json
No sample

Список юр.лиц

Возвращает список юридических лиц по заданному физическому лицу, где это физическое лицо является распорядителем.

path Parameters
id
required
integer

Идентификатор физ.лица

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Список распорядителей

Возвращает список физических лиц, являющихся распорядителями заданного юридического лица.

path Parameters
id
required
integer

Идентификатор юр.лица

query Parameters
page
integer

Номер страницы

per_page
string

Количество элементов на странице

sort
string
Default: "+created"
Enum: "+created" "-created"

Сортировка

states
string
Default: "Active,New,Inactive"
Enum: "Active" "New" "Inactive"
Example: states=Active,New

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Добавление распорядителя

Добавляем нового распорядителя к юридическому лицу с правом подписи или без права подписи. Привязка распорядителя происходит по номеру телефона, который находится в поле phone_number тела запроса.

В случае, если необходимо, чтобы распорядитель имел право подписывать документы и платежи, телефона необходимо установить в модели запроса признак is_organization_management:

  • true - нужно право подписи
  • false - ненужно право подписи
Authorizations:
Corporate_Data_API_Authorization
path Parameters
id
required
string

Идентификатор юридического лица

Request Body schema: application/json
is_organization_management
boolean

Признак полного распорядителя. true - распорядитель может подписывать документы, false - распорядитель не может подписывать документы.

signature_type
integer

Целочисленный тип подписи, например, 1 или 2

start_date
string <date>

Дата начала действия связи

end_date
string <date>

Срок окончания действия связи

phone_number
string

Номер телефона, если связь была добавлена по ролевой модели с привязкой по телефону.

relation_state
string

Тип связи (влияет на видимость и доступность юридического лица в списке доступных клиентов):

  • Active - активная связь, связанный клиент доступен;
  • New - связь "слабая", используется для доступа к Оператору без необходимости распоряжения средствами и связанный клиент недоступен в списке клиентов;
  • Inactive - связь неактивная (отозвана)
object (Corporate_Data_API_Customer)

Связанный клиент

full_name
string

Полное имя

object (Corporate_Data_API_Country)

Гражданство

object

Идентификационный документ

document_number
string

Полный номер идентификационного документа

document_issue_date
string <date-time>

Дата выдачи идентификационного документа

document_expire_date
string <date-time>

Срок действия идентификационного документа

object (Corporate_Data_API_Address)

Адрес регистрации/прописки

birth_date
string <date-time>

Дата рождения

object
tax_id
string

Налоговый идентификатор (ИНН)

Responses

Request samples

Content type
application/json
{
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string"
}

Response samples

Content type
application/json
{
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS",
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Правка распорядителя

Модификация данных распорядителя (по номеру телефона).

Authorizations:
Corporate_Data_API_Authorization
path Parameters
id
required
string

Идентификатор юридического лица

Request Body schema: application/json
is_organization_management
boolean

Признак полного распорядителя. true - распорядитель может подписывать документы, false - распорядитель не может подписывать документы.

signature_type
integer

Целочисленный тип подписи, например, 1 или 2

start_date
string <date>

Дата начала действия связи

end_date
string <date>

Срок окончания действия связи

phone_number
string

Номер телефона, если связь была добавлена по ролевой модели с привязкой по телефону.

relation_state
string

Тип связи (влияет на видимость и доступность юридического лица в списке доступных клиентов):

  • Active - активная связь, связанный клиент доступен;
  • New - связь "слабая", используется для доступа к Оператору без необходимости распоряжения средствами и связанный клиент недоступен в списке клиентов;
  • Inactive - связь неактивная (отозвана)
object (Corporate_Data_API_Customer)

Связанный клиент

full_name
string

Полное имя

object (Corporate_Data_API_Country)

Гражданство

object

Идентификационный документ

document_number
string

Полный номер идентификационного документа

document_issue_date
string <date-time>

Дата выдачи идентификационного документа

document_expire_date
string <date-time>

Срок действия идентификационного документа

object (Corporate_Data_API_Address)

Адрес регистрации/прописки

birth_date
string <date-time>

Дата рождения

object
tax_id
string

Налоговый идентификатор (ИНН)

Responses

Request samples

Content type
application/json
{
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string"
}

Response samples

Content type
application/json
{
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS",
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Удаление распорядителя

Удаляет распорядителя по номеру телефона. При удаление происходит мгновенное отключения доступа.

Authorizations:
Corporate_Data_API_Authorization
path Parameters
id
required
string

Идентификатор юр.лица

phone
required
string

Номер телефона распорядителя

Responses

Response samples

Content type
application/json
{
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Инициирование добавления распорядителя

Инициирование подписания

Authorizations:
Corporate_Data_API_Authorization
path Parameters
id
required
string

Идентификатор юридического лица

Request Body schema: application/json
otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту
is_organization_management
boolean

Признак полного распорядителя. true - распорядитель может подписывать документы, false - распорядитель не может подписывать документы.

signature_type
integer

Целочисленный тип подписи, например, 1 или 2

start_date
string <date>

Дата начала действия связи

end_date
string <date>

Срок окончания действия связи

phone_number
string

Номер телефона, если связь была добавлена по ролевой модели с привязкой по телефону.

relation_state
string

Тип связи (влияет на видимость и доступность юридического лица в списке доступных клиентов):

  • Active - активная связь, связанный клиент доступен;
  • New - связь "слабая", используется для доступа к Оператору без необходимости распоряжения средствами и связанный клиент недоступен в списке клиентов;
  • Inactive - связь неактивная (отозвана)
object (Corporate_Data_API_Customer)

Связанный клиент

full_name
string

Полное имя

object (Corporate_Data_API_Country)

Гражданство

object

Идентификационный документ

document_number
string

Полный номер идентификационного документа

document_issue_date
string <date-time>

Дата выдачи идентификационного документа

document_expire_date
string <date-time>

Срок действия идентификационного документа

object (Corporate_Data_API_Address)

Адрес регистрации/прописки

birth_date
string <date-time>

Дата рождения

object
tax_id
string

Налоговый идентификатор (ИНН)

Responses

Request samples

Content type
application/json
{
  • "otp": "0323",
  • "confirm_channel": "SMS",
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string"
}

Response samples

Content type
application/json
{
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Подтверждение распорядителя

Подписание модели данных распорядителя, после чего происходит их активация.

Authorizations:
Corporate_Data_API_Authorization
path Parameters
id
required
string
Request Body schema: application/json
otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту
is_organization_management
boolean

Признак полного распорядителя. true - распорядитель может подписывать документы, false - распорядитель не может подписывать документы.

signature_type
integer

Целочисленный тип подписи, например, 1 или 2

start_date
string <date>

Дата начала действия связи

end_date
string <date>

Срок окончания действия связи

phone_number
string

Номер телефона, если связь была добавлена по ролевой модели с привязкой по телефону.

relation_state
string

Тип связи (влияет на видимость и доступность юридического лица в списке доступных клиентов):

  • Active - активная связь, связанный клиент доступен;
  • New - связь "слабая", используется для доступа к Оператору без необходимости распоряжения средствами и связанный клиент недоступен в списке клиентов;
  • Inactive - связь неактивная (отозвана)
object (Corporate_Data_API_Customer)

Связанный клиент

full_name
string

Полное имя

object (Corporate_Data_API_Country)

Гражданство

object

Идентификационный документ

document_number
string

Полный номер идентификационного документа

document_issue_date
string <date-time>

Дата выдачи идентификационного документа

document_expire_date
string <date-time>

Срок действия идентификационного документа

object (Corporate_Data_API_Address)

Адрес регистрации/прописки

birth_date
string <date-time>

Дата рождения

object
tax_id
string

Налоговый идентификатор (ИНН)

Responses

Request samples

Content type
application/json
{
  • "otp": "0323",
  • "confirm_channel": "SMS",
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string"
}

Response samples

Content type
application/json
{
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Распорядитель по ID

Получения распорядителя по идентификатору распорядителя (affiliate_id) - идентификатор id в списке распорядителей.

path Parameters
id
required
string

ID клиента юридического лица

affiliate_id
required
string

ID распорядителя

Responses

Response samples

Content type
application/json
{
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Распорядитель по ID клиента

Получения распорядителя по идентификатору клиента - физ.лица (customer_id).

path Parameters
id
required
string

ID клиента юридического лица

customer_id
required
string

ID клиента физ.лица - распорядителя

Responses

Response samples

Content type
application/json
{
  • "is_organization_management": true,
  • "signature_type": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "phone_number": "string",
  • "relation_state": "string",
  • "customer": {
    },
  • "full_name": "string",
  • "nationality": {
    },
  • "document_type": {
    },
  • "document_number": "string",
  • "document_issue_date": "2004-12-17T00:00:00.000+00:00",
  • "document_expire_date": "2019-08-24T14:15:22Z",
  • "current_address": {
    },
  • "birth_date": "2019-08-24T14:15:22Z",
  • "gender": {
    },
  • "tax_id": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Accounts

Счета текущего клиента

Возвращает список открытых (активных) счетов текущего клиента

Authorizations:
Accounts_Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Счета данного клиента

Данная функция позволяет получить список счетов любого доступного клиента, не обязательно текущего.

Authorizations:
Accounts_Authorization
path Parameters
id
required
integer

Идентификатор клиента

query Parameters
states
Array of arrays
Default: "Active"
Items Enum: "Active" "Closed" "Inactive"

Статусы счетов

page
integer
Default: 0

Номер страницы

per_page
integer
Default: 25

Количество на страницу

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получение счета по ID

Authorizations:
Accounts_Authorization
path Parameters
id
required
integer

Идентификатор счета

Responses

Response samples

Content type
application/json
{
  • "currency": {
    },
  • "balance": 1234.56,
  • "estimated": 1235.55,
  • "ledger": 120.03,
  • "last_business_day": 0,
  • "business_day": "2019-08-24",
  • "limit": 0,
  • "minimum_amount": 0,
  • "type": "Common",
  • "coa": "Client",
  • "product_id": "string",
  • "customer": {
    },
  • "externals": [
    ],
  • "description": "string",
  • "blockades": [
    ],
  • "last_operation": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "state_changed": "2019-08-24T14:15:22Z",
  • "state": "Active",
  • "modes": [
    ]
}

Модификация счета

Позволяет модифицировать атрибут description у данного счета

Authorizations:
Accounts_Authorization
path Parameters
id
required
integer

Идентификатор счета

Request Body schema: application/json

В качестве тела запроса можно передавать модель счета целиком, однако, реально модицифируется только поле description. Минимальный состав модели - заполненные поля id и description.

object (Accounts_Asset)

Валюта счета

last_business_day
number

Остаток на последний закрытый операционный день.

business_day
string <date>

Дата последнего закрытого операционного дня.

limit
number

Неснижаемый остаток по счету

minimum_amount
number

Минимальная сумма пополнения

type
string
Enum: "Common" "Loan" "Deposit" "Escrow"

Тип счета

object (Accounts_Customer)

Клиент-владелец счета

Array of objects

Реквизиты счета в учетной системе внешнего провайдера.

description
string

Текстовое пользовательское название счета, например, "Расчетный счет"

Array of objects (Blockade)

Список блокировок, установленных для данного счета.

state
string
Enum: "Active" "Closed"

Статус счета

modes
Array of any
Items Enum: "inward" "outward"

Режимы счета:

  • inward - разрешены приходные операции
  • outward - разрешены расходные операции

Responses

Request samples

Content type
application/json
{
  • "currency": {
    },
  • "last_business_day": 0,
  • "business_day": "2019-08-24",
  • "limit": 0,
  • "minimum_amount": 0,
  • "type": "Common",
  • "customer": {
    },
  • "externals": [
    ],
  • "description": "string",
  • "blockades": [
    ],
  • "state": "Active",
  • "modes": [
    ]
}

Response samples

Content type
application/json
{
  • "currency": {
    },
  • "balance": 1234.56,
  • "estimated": 1235.55,
  • "ledger": 120.03,
  • "last_business_day": 0,
  • "business_day": "2019-08-24",
  • "limit": 0,
  • "minimum_amount": 0,
  • "type": "Common",
  • "coa": "Client",
  • "product_id": "string",
  • "customer": {
    },
  • "externals": [
    ],
  • "description": "string",
  • "blockades": [
    ],
  • "last_operation": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "state_changed": "2019-08-24T14:15:22Z",
  • "state": "Active",
  • "modes": [
    ]
}

Выписка по данному счету

Формирует выписку по счету в заданном диапазоне дат. Если начальная и конечная дата не указаны, то возвращается выписка только за текущий день.

В качестве даты операции рассматривается дата списания/зачисления в балансе провайдера.

Authorizations:
Accounts_Authorization
path Parameters
id
required
integer

Идентификатор счета

query Parameters
start
string <date>
Example: start=2022-12-01

Дата начала

end
string <date>
Example: end=2022-12-15

Дата окончания

group
boolean
Default: true

Нужна ли группировка по дням (true) или нет (false)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Блокады текущего клиента

Возвращает список всех активных блокировок, установленных для текущего клеинта

Authorizations:
Accounts_Authorization

Responses

Response samples

Content type
application/json
{
  • "amount": 12453.23,
  • "description": "string",
  • "account": {
    },
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Блокады заданного клиента

Возвращает список блокировок для указанного клиента

Authorizations:
Accounts_Authorization
path Parameters
id
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Инициация закрытия

Инициирует подписания заявление на закрытие счета

Authorizations:
Accounts_Authorization
path Parameters
id
required
integer

Идентификатор счета

Request Body schema: application/json
required
object (Accounts_Account)

Закрываемый счет

close_reason
string

Причина закрытия счета

otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Responses

Request samples

Content type
application/json
{
  • "currency": {
    },
  • "balance": 1234.56,
  • "estimated": 1235.55,
  • "type": "Common",
  • "coa": "Client",
  • "product_id": "string",
  • "customer": {
    },
  • "externals": [
    ],
  • "description": "string",
  • "blockades": [
    ],
  • "ledger": 120.03,
  • "last_operation": "2019-08-24T14:15:22Z",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "state": "string",
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS",
  • "state_info": "string",
  • "attrs": {
    },
  • "close_reason": "I dont like it anymore"
}

Response samples

Content type
application/json
{
  • "account": {
    },
  • "close_reason": "string",
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS"
}

Подтверждение закрытия

Подтверждает заявление на закрытие счета

Authorizations:
Accounts_Authorization
path Parameters
id
required
string
Request Body schema: application/json
required
object (Accounts_Account)

Закрываемый счет

close_reason
string

Причина закрытия счета

otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Responses

Request samples

Content type
application/json
{
  • "account": {
    },
  • "close_reason": "string",
  • "otp": "0323",
  • "confirm_channel": "SMS"
}

Response samples

Content type
application/json
{
  • "account": {
    },
  • "close_reason": "string",
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS"
}

Limits

Лимиты клиента

Получение списка примененных к данному клиенту лимитов

Authorizations:
Limits_Authorization
path Parameters
id
required
number

ID клиента

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Лимиты текущего клиента

Возвращает список лимитов текущего клиента

Authorizations:
Limits_Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transactions

Получение транзакции по ID

Возвращает данные транзакции по заданному идентификатору.

Authorizations:
Transactions_Authorization
path Parameters
id
required
integer

Идентификатор транзакции

Responses

Response samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "exchange_rate": 72.1078,
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "registry_type": 1,
  • "registry_remainder": 0,
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "state": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "attrs": {
    }
}

Модификация черновика

Выполняет модификацию транзакции (только для черновиков в статусе New, Draft и Validated), не меняя статус транзакции. Это позволяет создать платеж в статусе New, модифицировать его и отправить на валидацию, не генерируя черновиков (Draft).

Authorizations:
Transactions_Authorization
path Parameters
id
required
integer

Идентификатор транзакции

Request Body schema: application/json
details
string

Описание (назначение) транзакции

amount
number >= 0

Сумма транзакции по основному счету

object (Transactions_Account)

Основной счет транзакции

object (Transactions_Account)

Счет по другую сторону транзакции

related_amount
number >= 0

Сумма по другую сторону транзакции

object (Transactions_Asset)

Валюта (актив) по другую сторону транзакции

related_name
string

Наименование контрагента

transaction_type
string
Enum: "External" "Default" "Transfer" "Unregistered"

Тип транзакции. External - транзакция за пределы текущего финансовогоинститута; Default - транзакция внутри финансового института, Transfer - операция между своими счетами; Unregistered - платеж не клиенту с отправкой приглашения подключиться.

destination
string

Значение адреса получателя (если задан destination_type)

destination_type
string
Enum: "External" "Phone" "Email"

Тип адреса получателя (для быстрых транзакций)

direction
string
Default: 0
Enum: "0" "1"

Направление транзакции: 0 - исходящая, 1 - входящая

external_channel
string
Enum: "BankAccount" "Card" "PSP"

Вид внешнего канала отправки транзакции: BankAccount - платеж на банковский счет, Card - платеж на карту или пополнение с карты; PSP - операция через внешнюю платежную систему.

channel_id
string

Идентификатор внешнего канала, например, Stripe, SPB и пр.

sub_type
string

Кастомный подтип транзакции

sub_state
string

Кастомное дополнительное состояние транзакции

category
string

Специальная кастомная категория транзакции

id_parent
integer >= 0

Идентификатор родительской транзакции

executed
string <date-time>

Дата/время принятия транзакции к исполнению.

Array of objects

Список комиссий, которые возникают при исполнении транзакции.

origin
string

Происхождение транзакции - условный признак, для указания источника транзакции (например, когда транзация импортирована откуда-то).

parent_object_id
integer

Идентификатор родительского объекта, на основании которого была создана транзакция.

parent_object_type
string

Тип родительского объекта, породившего транзакцию. Например, "Transaction".

object (Transactions_Attributable)

Набор атрибутов представляет собой объект, чьи поля являются массивами значений.

Множественные атрибуты могут принимать несколько значений, отсортированных по порядку. Если значение атрибута только одно, то всё равно оно представляет собой массив из одного элемента.

Responses

Request samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "attrs": {
    }
}

Response samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "exchange_rate": 72.1078,
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "registry_type": 1,
  • "registry_remainder": 0,
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "state": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "attrs": {
    }
}

Удаление черновика

Удаление черновика транзакции

Authorizations:
Transactions_Authorization
path Parameters
id
required
integer

Идентификатор транзакции

Responses

Response samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "exchange_rate": 72.1078,
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "registry_type": 1,
  • "registry_remainder": 0,
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "state": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "attrs": {
    }
}

Создание черновика

Выполняет модификацию транзакции в состоянии New, переводя её в состояние черновик (Draft). Это позволяет в явном виде выполнить функцию "Сохранить черновик", переводя объект в статус Draft и тем самым он не будет перезаписать при попытке создать новую транзакцию через POST.

Authorizations:
Transactions_Authorization
path Parameters
id
required
integer

Идентификатор транзакции

Request Body schema: application/json
details
string

Описание (назначение) транзакции

amount
number >= 0

Сумма транзакции по основному счету

object (Transactions_Account)

Основной счет транзакции

object (Transactions_Account)

Счет по другую сторону транзакции

related_amount
number >= 0

Сумма по другую сторону транзакции

object (Transactions_Asset)

Валюта (актив) по другую сторону транзакции

related_name
string

Наименование контрагента

transaction_type
string
Enum: "External" "Default" "Transfer" "Unregistered"

Тип транзакции. External - транзакция за пределы текущего финансовогоинститута; Default - транзакция внутри финансового института, Transfer - операция между своими счетами; Unregistered - платеж не клиенту с отправкой приглашения подключиться.

destination
string

Значение адреса получателя (если задан destination_type)

destination_type
string
Enum: "External" "Phone" "Email"

Тип адреса получателя (для быстрых транзакций)

direction
string
Default: 0
Enum: "0" "1"

Направление транзакции: 0 - исходящая, 1 - входящая

external_channel
string
Enum: "BankAccount" "Card" "PSP"

Вид внешнего канала отправки транзакции: BankAccount - платеж на банковский счет, Card - платеж на карту или пополнение с карты; PSP - операция через внешнюю платежную систему.

channel_id
string

Идентификатор внешнего канала, например, Stripe, SPB и пр.

sub_type
string

Кастомный подтип транзакции

sub_state
string

Кастомное дополнительное состояние транзакции

category
string

Специальная кастомная категория транзакции

id_parent
integer >= 0

Идентификатор родительской транзакции

executed
string <date-time>

Дата/время принятия транзакции к исполнению.

Array of objects

Список комиссий, которые возникают при исполнении транзакции.

origin
string

Происхождение транзакции - условный признак, для указания источника транзакции (например, когда транзация импортирована откуда-то).

parent_object_id
integer

Идентификатор родительского объекта, на основании которого была создана транзакция.

parent_object_type
string

Тип родительского объекта, породившего транзакцию. Например, "Transaction".

object (Transactions_Attributable)

Набор атрибутов представляет собой объект, чьи поля являются массивами значений.

Множественные атрибуты могут принимать несколько значений, отсортированных по порядку. Если значение атрибута только одно, то всё равно оно представляет собой массив из одного элемента.

Responses

Request samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "attrs": {
    }
}

Response samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "exchange_rate": 72.1078,
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "registry_type": 1,
  • "registry_remainder": 0,
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "state": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "attrs": {
    }
}

Список транзакций

Возвращает список транзакций клиента, указанного по идентификатору id. Если параметр from не указан, то берутся транзакции за последние 6 месяцев. Если to не указан, то берутся транзакции до текущего дня включительно. Оба параметра поддерживают как ISO дату (например, 2020-03-20), так и ISO дату/время с или без указания временной зоны. При отсутствии временной зоны время интерпретируется по временной зоне финансовой организации.

В случае, если требуется запросить транзакции текущего клиента, то можно использовать сокращенный вариант /v1/transactions.

Кроме поиска по всем индексируемым атриюутам через параметр ?q= доступен поиск по дополнительным параметрам: amount, details, direction, related_name.

Поддерживается также поиск по дополнительным атриюутам, формат параметра: attrs.XXXXX, например, ?attrs.bank.seq_no=5 (поиск по номеру документа).

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Идентификатор клиента

query Parameters
page
integer
Default: 0

Номер страницы

per_page
integer
Default: 10

Количество элементов на страницу

sort
string
Default: "-executed"

Порядок сортировки по полю executed ("-" по убыванию, "+" по возрастанию)

from
string <date-time>
Default: "now() - 6M"
Example: from=2020-03-20 или 2020-03-20T20:00:00 (временная зона финансовой организации) или 2020-03-20T20:00:00+07:00 (с указанием временной зоны)

Дата, с которой нужно показывать транзакции (default: 6 месяцев, начиная с 00:00:00 во временной зоне финансовой организации)

to
string <date-time>
Default: "now()"
Example: to=2020-03-20 ил 2020-03-20T20:00:00 (временная зона финансовой организации) или 2020-03-20T20:00:00+07:00 (с указанием временной зоны)

Дата, до которой нужно показывать транзакции (default: текущая дата включительно до 23:59:59 по временной зоне финансовой организации)

direction
integer
Enum: 0 1
Example: direction=0

Фильтрация транзакций на входящие и исходящие

q
string

Поиск внутри имени контрагента, назначении платежа, реквизитах

amount
number

Поиск по сумме

related_name
string

Поиск по имени контрагента

details
string

Поиск по назначнию операции

attrs.*
string

Поиск по произвольным доп. атрибутам

account
integer

Идентификатор счета

Responses

Response samples

Content type
[
  • {
    }
]

Создание транзакции

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Идентификатор клиента

Request Body schema: application/json

Данные о транзакции

details
string

Описание (назначение) транзакции

amount
number >= 0

Сумма транзакции по основному счету

object (Transactions_Account)

Основной счет транзакции

object (Transactions_Account)

Счет по другую сторону транзакции

related_amount
number >= 0

Сумма по другую сторону транзакции

object (Transactions_Asset)

Валюта (актив) по другую сторону транзакции

related_name
string

Наименование контрагента

transaction_type
string
Enum: "External" "Default" "Transfer" "Unregistered"

Тип транзакции. External - транзакция за пределы текущего финансовогоинститута; Default - транзакция внутри финансового института, Transfer - операция между своими счетами; Unregistered - платеж не клиенту с отправкой приглашения подключиться.

destination
string

Значение адреса получателя (если задан destination_type)

destination_type
string
Enum: "External" "Phone" "Email"

Тип адреса получателя (для быстрых транзакций)

direction
string
Default: 0
Enum: "0" "1"

Направление транзакции: 0 - исходящая, 1 - входящая

external_channel
string
Enum: "BankAccount" "Card" "PSP"

Вид внешнего канала отправки транзакции: BankAccount - платеж на банковский счет, Card - платеж на карту или пополнение с карты; PSP - операция через внешнюю платежную систему.

channel_id
string

Идентификатор внешнего канала, например, Stripe, SPB и пр.

sub_type
string

Кастомный подтип транзакции

sub_state
string

Кастомное дополнительное состояние транзакции

category
string

Специальная кастомная категория транзакции

id_parent
integer >= 0

Идентификатор родительской транзакции

executed
string <date-time>

Дата/время принятия транзакции к исполнению.

Array of objects

Список комиссий, которые возникают при исполнении транзакции.

origin
string

Происхождение транзакции - условный признак, для указания источника транзакции (например, когда транзация импортирована откуда-то).

parent_object_id
integer

Идентификатор родительского объекта, на основании которого была создана транзакция.

parent_object_type
string

Тип родительского объекта, породившего транзакцию. Например, "Transaction".

object (Transactions_Attributable)

Набор атрибутов представляет собой объект, чьи поля являются массивами значений.

Множественные атрибуты могут принимать несколько значений, отсортированных по порядку. Если значение атрибута только одно, то всё равно оно представляет собой массив из одного элемента.

Request samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "attrs": {
    }
}

Проверка транзакции

Выполняет проверку полей транзакции на их корректность.

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Идентификатор транзакции

Request Body schema: application/json
details
string

Описание (назначение) транзакции

amount
number >= 0

Сумма транзакции по основному счету

object (Transactions_Account)

Основной счет транзакции

object (Transactions_Account)

Счет по другую сторону транзакции

related_amount
number >= 0

Сумма по другую сторону транзакции

object (Transactions_Asset)

Валюта (актив) по другую сторону транзакции

related_name
string

Наименование контрагента

transaction_type
string
Enum: "External" "Default" "Transfer" "Unregistered"

Тип транзакции. External - транзакция за пределы текущего финансовогоинститута; Default - транзакция внутри финансового института, Transfer - операция между своими счетами; Unregistered - платеж не клиенту с отправкой приглашения подключиться.

destination
string

Значение адреса получателя (если задан destination_type)

destination_type
string
Enum: "External" "Phone" "Email"

Тип адреса получателя (для быстрых транзакций)

direction
string
Default: 0
Enum: "0" "1"

Направление транзакции: 0 - исходящая, 1 - входящая

external_channel
string
Enum: "BankAccount" "Card" "PSP"

Вид внешнего канала отправки транзакции: BankAccount - платеж на банковский счет, Card - платеж на карту или пополнение с карты; PSP - операция через внешнюю платежную систему.

channel_id
string

Идентификатор внешнего канала, например, Stripe, SPB и пр.

sub_type
string

Кастомный подтип транзакции

sub_state
string

Кастомное дополнительное состояние транзакции

category
string

Специальная кастомная категория транзакции

id_parent
integer >= 0

Идентификатор родительской транзакции

executed
string <date-time>

Дата/время принятия транзакции к исполнению.

Array of objects

Список комиссий, которые возникают при исполнении транзакции.

origin
string

Происхождение транзакции - условный признак, для указания источника транзакции (например, когда транзация импортирована откуда-то).

parent_object_id
integer

Идентификатор родительского объекта, на основании которого была создана транзакция.

parent_object_type
string

Тип родительского объекта, породившего транзакцию. Например, "Transaction".

object (Transactions_Attributable)

Набор атрибутов представляет собой объект, чьи поля являются массивами значений.

Множественные атрибуты могут принимать несколько значений, отсортированных по порядку. Если значение атрибута только одно, то всё равно оно представляет собой массив из одного элемента.

Responses

Request samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "attrs": {
    }
}

Response samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "exchange_rate": 72.1078,
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "registry_type": 1,
  • "registry_remainder": 0,
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "state": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "attrs": {
    }
}

Инициализация подписания

Через выбранный канал (confirmation_channel) происходит инициализация подписания.

Например, если confirmation_channel = 'SMS', то происходит отправка одноразового кода через SMS.

Authorizations:
Transactions_Authorization
path Parameters
id
required
integer

Идентификатор транзакции

Request Body schema: application/json

Передаем валидированную модель транзакции

details
string

Описание (назначение) транзакции

amount
number >= 0

Сумма транзакции по основному счету

object (Transactions_Account)

Основной счет транзакции

object (Transactions_Account)

Счет по другую сторону транзакции

related_amount
number >= 0

Сумма по другую сторону транзакции

object (Transactions_Asset)

Валюта (актив) по другую сторону транзакции

related_name
string

Наименование контрагента

transaction_type
string
Enum: "External" "Default" "Transfer" "Unregistered"

Тип транзакции. External - транзакция за пределы текущего финансовогоинститута; Default - транзакция внутри финансового института, Transfer - операция между своими счетами; Unregistered - платеж не клиенту с отправкой приглашения подключиться.

destination
string

Значение адреса получателя (если задан destination_type)

destination_type
string
Enum: "External" "Phone" "Email"

Тип адреса получателя (для быстрых транзакций)

direction
string
Default: 0
Enum: "0" "1"

Направление транзакции: 0 - исходящая, 1 - входящая

external_channel
string
Enum: "BankAccount" "Card" "PSP"

Вид внешнего канала отправки транзакции: BankAccount - платеж на банковский счет, Card - платеж на карту или пополнение с карты; PSP - операция через внешнюю платежную систему.

channel_id
string

Идентификатор внешнего канала, например, Stripe, SPB и пр.

sub_type
string

Кастомный подтип транзакции

sub_state
string

Кастомное дополнительное состояние транзакции

category
string

Специальная кастомная категория транзакции

id_parent
integer >= 0

Идентификатор родительской транзакции

executed
string <date-time>

Дата/время принятия транзакции к исполнению.

Array of objects

Список комиссий, которые возникают при исполнении транзакции.

origin
string

Происхождение транзакции - условный признак, для указания источника транзакции (например, когда транзация импортирована откуда-то).

parent_object_id
integer

Идентификатор родительского объекта, на основании которого была создана транзакция.

parent_object_type
string

Тип родительского объекта, породившего транзакцию. Например, "Transaction".

object (Transactions_Attributable)

Набор атрибутов представляет собой объект, чьи поля являются массивами значений.

Множественные атрибуты могут принимать несколько значений, отсортированных по порядку. Если значение атрибута только одно, то всё равно оно представляет собой массив из одного элемента.

Responses

Request samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "attrs": {
    }
}

Response samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "exchange_rate": 72.1078,
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "registry_type": 1,
  • "registry_remainder": 0,
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "state": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "attrs": {
    }
}

Получение списка черновиков

Возвращает список черновиков текущего клиента. В случае, если требуется получить черновики текущего клиента, то можно использовать упрощенную функцию: /v1/transactions/drafts

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Идентификатор клиента

query Parameters
page
integer

Номер страницы

per_page
integer

Количество элементов на страницу

sort
string
Default: "-created"
Enum: "-created" "+created"

Направление сортировки по полю created

origin
string

Источник черновика

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Удаление черновиков

Удаляет ВСЕ черновики заданного клиента

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Идентификатор клиента

Responses

Response samples

Content type
application/json
0
0

Список транзакций по счету

Возвращает список транзакций для конкретного счета

Authorizations:
Transactions_Authorization
path Parameters
id
required
string
query Parameters
page
integer

Номер страницы

per_page
integer

Количество элементов на страницу

sort
string
Default: "-executed"
Enum: "-executed" "+executed"

Порядок сортировки по полю executed

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Подтверждение подписания

В случае, если выполняется подписание транзакции одноразовым кодиком, то данная функция позволяет указать кодик в теле транзакции и отправить на валидацию подписи.

Authorizations:
Transactions_Authorization
path Parameters
id
required
integer

Идентификатор транзакции

Request Body schema: application/json

Модель транзакции должна в точности совпадать с той, которая вернулась от /transactions/{id}/sign

details
string

Описание (назначение) транзакции

amount
number >= 0

Сумма транзакции по основному счету

object (Transactions_Account)

Основной счет транзакции

object (Transactions_Account)

Счет по другую сторону транзакции

related_amount
number >= 0

Сумма по другую сторону транзакции

object (Transactions_Asset)

Валюта (актив) по другую сторону транзакции

related_name
string

Наименование контрагента

transaction_type
string
Enum: "External" "Default" "Transfer" "Unregistered"

Тип транзакции. External - транзакция за пределы текущего финансовогоинститута; Default - транзакция внутри финансового института, Transfer - операция между своими счетами; Unregistered - платеж не клиенту с отправкой приглашения подключиться.

destination
string

Значение адреса получателя (если задан destination_type)

destination_type
string
Enum: "External" "Phone" "Email"

Тип адреса получателя (для быстрых транзакций)

direction
string
Default: 0
Enum: "0" "1"

Направление транзакции: 0 - исходящая, 1 - входящая

external_channel
string
Enum: "BankAccount" "Card" "PSP"

Вид внешнего канала отправки транзакции: BankAccount - платеж на банковский счет, Card - платеж на карту или пополнение с карты; PSP - операция через внешнюю платежную систему.

channel_id
string

Идентификатор внешнего канала, например, Stripe, SPB и пр.

sub_type
string

Кастомный подтип транзакции

sub_state
string

Кастомное дополнительное состояние транзакции

category
string

Специальная кастомная категория транзакции

id_parent
integer >= 0

Идентификатор родительской транзакции

executed
string <date-time>

Дата/время принятия транзакции к исполнению.

Array of objects

Список комиссий, которые возникают при исполнении транзакции.

origin
string

Происхождение транзакции - условный признак, для указания источника транзакции (например, когда транзация импортирована откуда-то).

parent_object_id
integer

Идентификатор родительского объекта, на основании которого была создана транзакция.

parent_object_type
string

Тип родительского объекта, породившего транзакцию. Например, "Transaction".

object (Transactions_Attributable)

Набор атрибутов представляет собой объект, чьи поля являются массивами значений.

Множественные атрибуты могут принимать несколько значений, отсортированных по порядку. Если значение атрибута только одно, то всё равно оно представляет собой массив из одного элемента.

Responses

Request samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "attrs": {
    }
}

Response samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "exchange_rate": 72.1078,
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "registry_type": 1,
  • "registry_remainder": 0,
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "state": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "attrs": {
    }
}

Отмена транзакции

Отменяет транзакцию в статусе Validated или Unconfirmed и переводит в статус Draft (черновик).

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

ID транзакции

Responses

Response samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "exchange_rate": 72.1078,
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "registry_type": 1,
  • "registry_remainder": 0,
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "state": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "attrs": {
    }
}

Количество черновиков

Возвращает количество черновиков транзакций для заданного клиента. Для текущего клиента есть упрощенный формат функции '/v1/transactions/drafts/count'.

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Идентификатор клиента

query Parameters
origin
string

Код системы - происхождения транзакакции

Responses

Response samples

Content type
application/json
2

Картотека

Возвращает список транзакций, которые находятся в картотеке (1 или 2), принадлежащих клиенту, заданному идентификатором id.

Если необходимо получить список транзакций текущего клиента, то можно использовать сокращенный endpoint /v1/transactions/registry.

Authorizations:
Transactions_Authorization
path Parameters
id
required
string
query Parameters
sort
string
Default: "-created"
Example: sort=-created или +created

Сортировка по дате создания

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Резервы

Возвращает список резервов (например, карточных холдов), принадлежащих клиенту, заданному идентификатором id.

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Идентификатор клиента

query Parameters
sort
string
Default: "-executed"
Example: sort=-executed или +executed

Сортировка по дате исполнения

page
string

Номер страницы

per_page
string

Количество элементов на странице

Responses

Response samples

Content type
application/json
[
  • {
    }
]

История событий

Возвращает список событий, которые происходили с транзакцией по указанному идентификатору id.

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Дочерние транзакции

Возвращает список транзакций, дочерних по отношению к данной.

Например, если исходная транзакция (id) имеет статус Registry, т.е. "картотека", то данная функция вернет список частичных оплат картотеки.

Authorizations:
Transactions_Authorization
path Parameters
id
required
number

Идентификатор родительской транзакции

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Предварительная валидация транзакции

Данный метод позволяет провалидировать любую модель транзакции без необходимости её создания.

Authorizations:
Transactions_Authorization
Request Body schema: application/json
details
string

Описание (назначение) транзакции

amount
number >= 0

Сумма транзакции по основному счету

object (Transactions_Account)

Основной счет транзакции

object (Transactions_Account)

Счет по другую сторону транзакции

related_amount
number >= 0

Сумма по другую сторону транзакции

object (Transactions_Asset)

Валюта (актив) по другую сторону транзакции

related_name
string

Наименование контрагента

transaction_type
string
Enum: "External" "Default" "Transfer" "Unregistered"

Тип транзакции. External - транзакция за пределы текущего финансовогоинститута; Default - транзакция внутри финансового института, Transfer - операция между своими счетами; Unregistered - платеж не клиенту с отправкой приглашения подключиться.

destination
string

Значение адреса получателя (если задан destination_type)

destination_type
string
Enum: "External" "Phone" "Email"

Тип адреса получателя (для быстрых транзакций)

direction
string
Default: 0
Enum: "0" "1"

Направление транзакции: 0 - исходящая, 1 - входящая

external_channel
string
Enum: "BankAccount" "Card" "PSP"

Вид внешнего канала отправки транзакции: BankAccount - платеж на банковский счет, Card - платеж на карту или пополнение с карты; PSP - операция через внешнюю платежную систему.

channel_id
string

Идентификатор внешнего канала, например, Stripe, SPB и пр.

sub_type
string

Кастомный подтип транзакции

sub_state
string

Кастомное дополнительное состояние транзакции

category
string

Специальная кастомная категория транзакции

id_parent
integer >= 0

Идентификатор родительской транзакции

executed
string <date-time>

Дата/время принятия транзакции к исполнению.

Array of objects

Список комиссий, которые возникают при исполнении транзакции.

origin
string

Происхождение транзакции - условный признак, для указания источника транзакции (например, когда транзация импортирована откуда-то).

parent_object_id
integer

Идентификатор родительского объекта, на основании которого была создана транзакция.

parent_object_type
string

Тип родительского объекта, породившего транзакцию. Например, "Transaction".

object (Transactions_Attributable)

Набор атрибутов представляет собой объект, чьи поля являются массивами значений.

Множественные атрибуты могут принимать несколько значений, отсортированных по порядку. Если значение атрибута только одно, то всё равно оно представляет собой массив из одного элемента.

Responses

Request samples

Content type
application/json
{
  • "details": "string",
  • "amount": 12345.93,
  • "account": {
    },
  • "related_account": {
    },
  • "related_amount": 0,
  • "related_currency": {
    },
  • "related_name": "string",
  • "transaction_type": "External",
  • "destination": "string",
  • "destination_type": "External",
  • "direction": "0",
  • "external_channel": "BankAccount",
  • "channel_id": "string",
  • "sub_type": "string",
  • "sub_state": "string",
  • "category": "string",
  • "id_parent": 0,
  • "executed": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "origin": "string",
  • "parent_object_id": 0,
  • "parent_object_type": "string",
  • "attrs": {
    }
}

Response samples

Content type
application/json
No sample

Инициализация пакетного подписания

Функция принимает список транзакций (см. Batch) и в результирующей модели возвращается идентификатор пакета, который используется в дальнейшем при подтверждении пакета. Фактически идентификатор пакета - это идентификатор первой транзакции в списке.

В атрибутах пакета Batch будут выставлены атрибуты, показывающие общую сумму транзакций, сгруппированную по валютам, например:

    "id" : 1234567,
...
    "attrs": {
        "total.amount" : [200.00, 15.02],
        "total.currency" : ["RUB", "USD"],
        "total.asset" : ["4031931d353f4f0aa1c50bcd679b7496", "2124e68736bc4cd1be359372fed5f101"]
    }
....

В атрибуте total.asset пишутся идентификаторы валют/активов.

Authorizations:
Transactions_Authorization
Request Body schema: application/json
Array of objects (Transactions_AbstractObject)
otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ],
  • "otp": "0323",
  • "confirm_channel": "SMS"
}

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS"
}

Подтверждение подписания пакета транзакций

Authorizations:
Transactions_Authorization
path Parameters
id
required
integer

Идентификатор пакета

Request Body schema: application/json
Array of objects (Transactions_AbstractObject)
otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ],
  • "otp": "0323",
  • "confirm_channel": "SMS"
}

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS"
}

Создание пакета черновиков

Создание пакета черновиков на основании списка моделей транзакций.

Authorizations:
Transactions_Authorization
Request Body schema: application/json

Внутри entities должен быть массив транзакций

Array of objects (Transactions_AbstractObject)
otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Request samples

Content type
application/json
{
  • "entities": [
    ],
  • "otp": "0323",
  • "confirm_channel": "SMS"
}

Реверс проводок

Данная операция позволяет аннулировать указанные проводки.\nПри этом аннулирование всех проводок приводит к автоматическому аннулированию всей транзакции.

Authorizations:
Transactions_Authorization
Request Body schema: application/json
original_ids
required
Array of integers

Список идентификаторов проводок

forced
boolean

true, если исходную транзакцию нужно пометить как удаленную и затереть все внешние идентификаторы проводок.

Responses

Request samples

Content type
application/json
{
  • "original_ids": [
    ],
  • "forced": true
}

Response samples

Content type
application/json
{
  • "original_ids": [
    ],
  • "reverse_ids": [
    ],
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

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

Возвращает список идентификаторов проводок, связанных с заданным объектом. Например, type может быть равен Transaction, а идентификатор - идентификатор транзакции в Платформе.

Authorizations:
Transactions_Authorization
path Parameters
id
required
string

Идентификатор объекта

type
required
string
Value: "Transaction"

Тип объекта

Responses

Response samples

Content type
application/json
{
  • "original_ids": [
    ]
}

AcceptPayments

Валидация платежа

Проверка возможности совершения операции пополнения счета. Идентификатор платежа во внешней платежной системе необходимо указывать в url.

Authorizations:
AcceptPayments_Authorization
path Parameters
externalId
required
string

Идентификатор платежа

Request Body schema: application/json
destination
required
string

Реквизит платежа - обычно номер телефона или адрес электронной почты получателя.

destination_type
any
Enum: "Phone" "Email"

Тип реквизита для зачисления, по умолчаению Phone

amount
number <double> >= 0.01

Сумма операции. В случае, если выполняется валидация платежа, то не является обязательным полем.

currency
string

Код валюты. Используется в случае, если поддерживается возможность взноса денежных средств в разных валютах.

Если не указана, то всегда используется валюта, доступная оператору по умолчанию.

timestamp
string <date-time>

Время в системе учете оператора пополнения счета.

Responses

Request samples

Content type
application/json
{
  • "destination": "string",
  • "destination_type": "Phone",
  • "amount": 100,
  • "currency": "string",
  • "timestamp": "2023-10-30T14:03:26.999+00:00"
}

Response samples

Content type
application/json
{
  • "state": "Confirmed",
  • "message": "string",
  • "id": 0,
  • "destination": "string",
  • "destination_type": "Phone",
  • "amount": 0.01,
  • "currency": "string",
  • "timestamp": "2023-10-30T14:03:26.999+00:00"
}

Исполнение платежа

Исполнение платежа на указанную сумму по указанному реквизиту. Идентификатор платежа во внешней платежной системе необходимо указывать в url.

Authorizations:
AcceptPayments_Authorization
path Parameters
externalId
required
string

Идентификатор платежа

Request Body schema: application/json
destination
required
string

Реквизит платежа - обычно номер телефона или адрес электронной почты получателя.

destination_type
any
Enum: "Phone" "Email"

Тип реквизита для зачисления, по умолчаению Phone

amount
number <double> >= 0.01

Сумма операции. В случае, если выполняется валидация платежа, то не является обязательным полем.

currency
string

Код валюты. Используется в случае, если поддерживается возможность взноса денежных средств в разных валютах.

Если не указана, то всегда используется валюта, доступная оператору по умолчанию.

timestamp
string <date-time>

Время в системе учете оператора пополнения счета.

Responses

Request samples

Content type
application/json
{
  • "destination": "string",
  • "destination_type": "Phone",
  • "amount": 100,
  • "currency": "string",
  • "timestamp": "2023-10-30T14:03:26.999+00:00"
}

Response samples

Content type
application/json
{
  • "state": "Confirmed",
  • "message": "string",
  • "id": 0,
  • "destination": "string",
  • "destination_type": "Phone",
  • "amount": 0.01,
  • "currency": "string",
  • "timestamp": "2023-10-30T14:03:26.999+00:00"
}

Статус платежа

Проверка текущего статуса платежа, поскольку принятый системой платеж может быть проведен по счетам чуть позже, либо же в исполнении отказано, если реальное исполнение транзакции происходит во внешнем леджере (например, в АБС банка).

Authorizations:
AcceptPayments_Authorization
path Parameters
externalId
required
string

Идентификатор платежи

Responses

Response samples

Content type
application/json
{
  • "state": "Confirmed",
  • "message": "string",
  • "id": 0,
  • "destination": "string",
  • "destination_type": "Phone",
  • "amount": 0.01,
  • "currency": "string",
  • "timestamp": "2023-10-30T14:03:26.999+00:00"
}

Counterparty

Работа с контрагентом

Получение контрагента по его идентификатору

Authorizations:
Counterparty_API_Authorization
path Parameters
id
required
string

ID контрагента

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "account_owner_name": "string",
  • "account_number": "string",
  • "bank_code_type": "LOCAL",
  • "bank_code": "string",
  • "tax_id": "string",
  • "country": {
    },
  • "details": "string",
  • "description": "string"
}

Модификация контрагента

Модификация контрагента

Authorizations:
Counterparty_API_Authorization
path Parameters
id
required
string

ID контрагента

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "account_owner_name": "string",
  • "account_number": "string",
  • "bank_code_type": "LOCAL",
  • "bank_code": "string",
  • "tax_id": "string",
  • "country": {
    },
  • "details": "string",
  • "description": "string"
}

Удаление контрагента

Удаление заданного контрагента

Authorizations:
Counterparty_API_Authorization
path Parameters
id
required
string

ID контрагента

Responses

Список контрагентов

Получение списка контрагентов текущего клиента

Authorizations:
Counterparty_API_Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Новый контрагент

Создание нового контрагента.

Контрагенты создаются автоматически при создании транзакций. Для этого используются следующие доп. атрибуты транзакций:

  • bank.save_counterparty
  • bank.id

Если указан атрибут 'bank.save_counterparty', то при исполнении транзакции происходит автоматическое сохранение контрагента.

Если дополнительно указан атрибут 'bank.id' равный идентификатору объекта Counterparty, то происходит обновление данных указанного контрагента данными из транзакции.

Request Body schema: application/json
id
required
integer

ID объекта

account_owner_name
string

Наименование владельца счета

account_number
string

Номер счета

bank_code_type
string
Enum: "LOCAL" "SWIFT"

Тип банка (LOCAL - справочник внутри страны, SWIFT-глобальный справочник SWIFT-кодов)

bank_code
string

Код банка, например, 046551854

tax_id
string

Налоговый идентификатор (ИНН в России)

object (Counterparty_API_Country)

Справочник стран

details
string

Детали операции - назначение платежа

description
string

Пользовательское описание контрагентов

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "account_owner_name": "string",
  • "account_number": "string",
  • "bank_code_type": "LOCAL",
  • "bank_code": "string",
  • "tax_id": "string",
  • "country": {
    },
  • "details": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "account_owner_name": "string",
  • "account_number": "string",
  • "bank_code_type": "LOCAL",
  • "bank_code": "string",
  • "tax_id": "string",
  • "country": {
    },
  • "details": "string",
  • "description": "string"
}

Контрагенты клиента

Получение списка контрагентов у клиента, заданного идентификатором

Authorizations:
Counterparty_API_Authorization
path Parameters
id
required
number

ID клиента

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deposits

Открытие депозита

Создание новой заявки на депозит.

Authorizations:
Deposits_Authorization
Request Body schema: application/json
term
integer

Срок контракта в единицах (месяцы или дни).

object (Deposits_Customer)

Клиент - владелец депозита

product_type
required
string

Тип депозита

object (Deposits_Account)

Основной счет депозита

required
object (Deposits_Asset)

Валюта (или иной актив) депозита

title
string

Наименование депозитного продукта

amount
required
number

Сумма депозита

object (Deposits_Account)

Собственный счет для распоряжения

object (Deposits_Counterparty)

Счет распоряжения процентами в другом банке

object (Deposits_Account)

Собственный счет-источник средства пополнения депозита

object (Deposits_Counterparty)

Счет-источник для пополнения депозита в другом банке

object (Deposits_Account)

Собственный счет перечисления депозита после окончания срока

object (Deposits_Counterparty)

Счет в другом банке для перечисления депозита после окончания срока

contract_date
string <date>

Дата распоряжения об открытии депозита

contract_number
string

Номер распоряжения (договора) депо

Responses

Request samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "amount": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string"
}

Response samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "refill_start": "2019-08-24",
  • "refill_end": "2019-08-24",
  • "amount": 0,
  • "interest": "string",
  • "accumulated_interest": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Детали депозита

Запрос деталей депозитного договора

Authorizations:
Deposits_Authorization
path Parameters
id
required
integer

Идентификатор депозита

Responses

Response samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "refill_start": "2019-08-24",
  • "refill_end": "2019-08-24",
  • "amount": 0,
  • "interest": "string",
  • "accumulated_interest": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Правка депозита

Корректировка данных заявки на депозит. Такая корректировка возможна, пока депозитный договор находится в статусе New и не подписан со стороны клиента.

Authorizations:
Deposits_Authorization
path Parameters
id
required
integer

Идентификатор депозита

Request Body schema: application/json
term
integer

Срок контракта в единицах (месяцы или дни).

object (Deposits_Customer)

Клиент - владелец депозита

product_type
required
string

Тип депозита

object (Deposits_Account)

Основной счет депозита

required
object (Deposits_Asset)

Валюта (или иной актив) депозита

title
string

Наименование депозитного продукта

amount
required
number

Сумма депозита

object (Deposits_Account)

Собственный счет для распоряжения

object (Deposits_Counterparty)

Счет распоряжения процентами в другом банке

object (Deposits_Account)

Собственный счет-источник средства пополнения депозита

object (Deposits_Counterparty)

Счет-источник для пополнения депозита в другом банке

object (Deposits_Account)

Собственный счет перечисления депозита после окончания срока

object (Deposits_Counterparty)

Счет в другом банке для перечисления депозита после окончания срока

contract_date
string <date>

Дата распоряжения об открытии депозита

contract_number
string

Номер распоряжения (договора) депо

Responses

Request samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "amount": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string"
}

Response samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "refill_start": "2019-08-24",
  • "refill_end": "2019-08-24",
  • "amount": 0,
  • "interest": "string",
  • "accumulated_interest": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Удаление депозита

Удаление неотправленной заявки на депозит.

Authorizations:
Deposits_Authorization
path Parameters
id
required
integer

Идентификатор депозита

Responses

Response samples

Content type
application/json
{ }

Инициализация подписания

Иницирует процедуру подписания депозитного договора.

Authorizations:
Deposits_Authorization
path Parameters
id
required
integer

Идентификатор депозита

Request Body schema: application/json
term
integer

Срок контракта в единицах (месяцы или дни).

object (Deposits_Customer)

Клиент - владелец депозита

product_type
required
string

Тип депозита

object (Deposits_Account)

Основной счет депозита

required
object (Deposits_Asset)

Валюта (или иной актив) депозита

title
string

Наименование депозитного продукта

amount
required
number

Сумма депозита

object (Deposits_Account)

Собственный счет для распоряжения

object (Deposits_Counterparty)

Счет распоряжения процентами в другом банке

object (Deposits_Account)

Собственный счет-источник средства пополнения депозита

object (Deposits_Counterparty)

Счет-источник для пополнения депозита в другом банке

object (Deposits_Account)

Собственный счет перечисления депозита после окончания срока

object (Deposits_Counterparty)

Счет в другом банке для перечисления депозита после окончания срока

contract_date
string <date>

Дата распоряжения об открытии депозита

contract_number
string

Номер распоряжения (договора) депо

otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Responses

Request samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "amount": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string",
  • "otp": "0323",
  • "confirm_channel": "SMS"
}

Response samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "refill_start": "2019-08-24",
  • "refill_end": "2019-08-24",
  • "amount": 0,
  • "interest": "string",
  • "accumulated_interest": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS"
}

Подтверждение подписания

Подтверждение подписание заявки на депозит

Authorizations:
Deposits_Authorization
path Parameters
id
required
string
Request Body schema: application/json
term
integer

Срок контракта в единицах (месяцы или дни).

object (Deposits_Customer)

Клиент - владелец депозита

product_type
required
string

Тип депозита

object (Deposits_Account)

Основной счет депозита

required
object (Deposits_Asset)

Валюта (или иной актив) депозита

title
string

Наименование депозитного продукта

amount
required
number

Сумма депозита

object (Deposits_Account)

Собственный счет для распоряжения

object (Deposits_Counterparty)

Счет распоряжения процентами в другом банке

object (Deposits_Account)

Собственный счет-источник средства пополнения депозита

object (Deposits_Counterparty)

Счет-источник для пополнения депозита в другом банке

object (Deposits_Account)

Собственный счет перечисления депозита после окончания срока

object (Deposits_Counterparty)

Счет в другом банке для перечисления депозита после окончания срока

contract_date
string <date>

Дата распоряжения об открытии депозита

contract_number
string

Номер распоряжения (договора) депо

otp
string = 4 characters d{4}

Значение одноразового кодика. Сделано строкой, чтобы иметь возможность создавать кодики с ведущими нулями.

confirm_channel
string
Enum: "SMS" "TRUSTED" "EMAIL"

Канал, который используется для подтверждения:

  • SMS - доставка кодика идет через SMS
  • TRUSTED - используется доверенный канал, когда платформа сама проверяет факт наличия подписи во внешней системе подписания.
  • EMAIL - доставка кодика через почту

Responses

Request samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "amount": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string",
  • "otp": "0323",
  • "confirm_channel": "SMS"
}

Response samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "refill_start": "2019-08-24",
  • "refill_end": "2019-08-24",
  • "amount": 0,
  • "interest": "string",
  • "accumulated_interest": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00",
  • "otp": "0323",
  • "otp_num": 0,
  • "otp_time": "2019-08-24T14:15:22Z",
  • "confirm_channel": "SMS"
}

Список депозитов

Возвращает список продуктов, доступных текущему клиенту, в том числе депозитные договоры.

Authorizations:
Deposits_Authorization
path Parameters
id
required
integer

Идентификатор клиента

query Parameters
states
Array of arrays
Default: "Active,Pending"
Items Enum: "New" "Active" "Pending" "Suspended" "Inactive"

Статусы продуктов

page
integer >= 0
Default: 0

Номер страницы

per_page
integer >= 1
Default: 10

Количество элементов на страницу

sort
string
Default: "-created"

Порядок сортировки по полю created ("-" по убыванию, "+" по возрастанию)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Правка счетов

Корректирует счета распоряжения процентами и счета для перечисления депозита после его закрытия.

Отличие этой функции от обычной правки заявки на депозит в том, что счета могут меняться для уже действующих депозитов.

Authorizations:
Deposits_Authorization
path Parameters
id
required
string
Request Body schema: application/json
term
integer

Срок контракта в единицах (месяцы или дни).

object (Deposits_Customer)

Клиент - владелец депозита

product_type
required
string

Тип депозита

object (Deposits_Account)

Основной счет депозита

required
object (Deposits_Asset)

Валюта (или иной актив) депозита

title
string

Наименование депозитного продукта

amount
required
number

Сумма депозита

object (Deposits_Account)

Собственный счет для распоряжения

object (Deposits_Counterparty)

Счет распоряжения процентами в другом банке

object (Deposits_Account)

Собственный счет-источник средства пополнения депозита

object (Deposits_Counterparty)

Счет-источник для пополнения депозита в другом банке

object (Deposits_Account)

Собственный счет перечисления депозита после окончания срока

object (Deposits_Counterparty)

Счет в другом банке для перечисления депозита после окончания срока

contract_date
string <date>

Дата распоряжения об открытии депозита

contract_number
string

Номер распоряжения (договора) депо

Responses

Request samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "amount": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string"
}

Response samples

Content type
application/json
{
  • "term": 0,
  • "customer": {
    },
  • "product_type": "string",
  • "account": {
    },
  • "asset": {
    },
  • "title": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "refill_start": "2019-08-24",
  • "refill_end": "2019-08-24",
  • "amount": 0,
  • "interest": "string",
  • "accumulated_interest": 0,
  • "interest_account": {
    },
  • "interest_account_external": {
    },
  • "source_account": {
    },
  • "source_account_external": {
    },
  • "target_account": {
    },
  • "target_account_external": {
    },
  • "contract_date": "2019-08-24",
  • "contract_number": "string",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Authentication

Аутентификация сервисной учетки

Сервисная учетка используется интеграторами для того, чтобы использовать более простой способ получения доступа у необходимым функциям.

Сервисная учетка предоставляется в виде пары userName, password, а также для работы с ней требуется зарегистрированное приложение в виде пары client_id/client_secret.

Authorizations:
Authentication_BasicAuth
Request Body schema: application/x-www-form-urlencoded
  1. Для получения пары access_token/refresh_token используется следующий формат тела запроса:
grant_type=password&username=${USER}&password=${PASSWORD}&scope=full

${USER} - имя пользователя сервисной учетки.

${PASSWORD} - пароль от учетки.

  1. Для выполнения операции refresh_token необходимо передать тело запроса:
grant_type=refresh_token&client_id=${client_id}&client_secret=${client_secret}&refresh_token=${refresh_token}
  1. Также следует обратить внимание, что в заголовке Authentication должна быть передана заколированная в Base64 строка в следующем виде:
  Authentication: Basic base64(client_id:client_secret)

, что является стандартным в OAuth2 протоколе.

string

Responses

Request samples

Content type
application/x-www-form-urlencoded
No sample

Response samples

Content type
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "token_type": "bearer",
  • "expires_in": 0,
  • "scope": "string",
  • "client_id": "string"
}

Security

Доп. аутентификация

Подтверждение доп. аутентификации при помощи OTP. В случае успеха текущий пользователь получает окончательную роль ROLE_USER.

Authorizations:
Security_Authorization
Request Body schema: application/json

Модель с переданным OTP

otp
required
string

Одноразовый код

Responses

Request samples

Content type
application/json
{
  • "otp": "string"
}

Response samples

Content type
application/json
{ }

Повторный запрос OTP

Запрос нового кодика (SMS) для аутентификации.

Authorizations:
Security_Authorization
Request Body schema: application/json

Пустое тело запроса

auth_channel
required
string
Value: "SMS"

Канал доп. аутентификации

Responses

Request samples

Content type
application/json
{
  • "auth_channel": "SMS"
}

Response samples

Content type
application/json
{
  • "auth_channel": "SMS",
  • "login": "string",
  • "name": "string",
  • "locale_id": "ru_RU",
  • "roles": [
    ],
  • "customers": [
    ],
  • "customer": 0,
  • "client_id": "string",
  • "user_customer": 0
}

Установить PIN

Устанавливает короткий 4-х циферный PIN-код, который может быть использован, например, в мобильных приложениях/

Authorizations:
Security_Authorization
Request Body schema: application/json
pin
required
string = 4 characters \d{4}

Строка с PIN-кодом

Responses

Request samples

Content type
application/json
{
  • "pin": "1234"
}

Проверка PIN

Выполняет проверку ранее установленного короткого PIN-кода.

Authorizations:
Security_Authorization
Request Body schema: application/json
pin
required
string = 4 characters

4-циферный PIN-код

Responses

Request samples

Content type
application/json
{
  • "pin": "1234"
}

Merchants

Данные о мерчанте

Получение информации о мерчанте по его идентификатору

path Parameters
id
required
string

Идентификатор мерчанта

Responses

Response samples

Content type
application/json
No sample

Модификация мерчанта

Обновление данных о мерчанте

path Parameters
id
required
string

Идентификатор мерчанта

Request Body schema: application/json
name
string

Название (бренд) торговой точки

object (Merchants_Address)

Адрес торговой точки

latitude
string

Координаты - широта

longitude
string

Координаты - долгота

object (Merchants_Customer)

Ссылка на связанного клиента

category
string

Категория торговой точки

mcc
string

Код MCC

phone
string

Контактный телефон торговой точки

zone_id
string

Код временной зоны, например, Asia/Singapore

Array of objects (Merchants_ExternalEntity)

Список внешних идентификаторов, связанных с заданным мерчантом.

default_merchant
boolean

Признак торговой точки по умолчанию

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "shop_address": {
    },
  • "latitude": "string",
  • "longitude": "string",
  • "customer": {
    },
  • "category": "string",
  • "mcc": "string",
  • "phone": "string",
  • "zone_id": "string",
  • "externals": [
    ],
  • "default_merchant": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "shop_address": {
    },
  • "latitude": "string",
  • "longitude": "string",
  • "customer": {
    },
  • "category": "string",
  • "mcc": "string",
  • "phone": "string",
  • "zone_id": "string",
  • "externals": [
    ],
  • "default_merchant": true,
  • "registration_mode": "Full",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Новый мерчант

Создание новой торговой точки (мерчанта) с заданными параметрами для указанного клиента. Клиент должен быть юридическим лицом. По умолчанию мерчант создается в статусе New.

Если нет необходимости дальнейшей регистрации мерчанта, то при создании ему можно сразу же присвоить статус state = 'Active', чтобы сделать доступным.

path Parameters
id
required
string

Идентификатор клиента

Request Body schema: application/json
name
string

Название (бренд) торговой точки

object (Merchants_Address)

Адрес торговой точки

latitude
string

Координаты - широта

longitude
string

Координаты - долгота

object (Merchants_Customer)

Ссылка на связанного клиента

category
string

Категория торговой точки

mcc
string

Код MCC

phone
string

Контактный телефон торговой точки

zone_id
string

Код временной зоны, например, Asia/Singapore

Array of objects (Merchants_ExternalEntity)

Список внешних идентификаторов, связанных с заданным мерчантом.

default_merchant
boolean

Признак торговой точки по умолчанию

Responses

Request samples

Content type
application/json
{
  • "firstName": "Bob",
  • "lastName": "Fellow",
  • "email": "bob.fellow@gmail.com",
  • "dateOfBirth": "1996-08-24"
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "firstName": "Bob",
  • "lastName": "Fellow",
  • "email": "bob.fellow@gmail.com",
  • "dateOfBirth": "1996-08-24",
  • "emailVerified": false,
  • "createDate": "2020-11-18"
}

Список мерчантов

Возвращает список мерчантов по данному идентификатору клиента.

path Parameters
id
required
string

Идентификатор клиента

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Регистрация мерчанта

Выполняет регистрацию мерчанта во внешних платежных системах, если это необходимо. Процесс регистрации, как правило, асинхронный.

В начале регистрации статус мерчанта меняется на Pending, а затем, при успешном завершении регистрации, становится Active.

В случае, если регистрация заканчивается ошибкой, то присваивается статус Failed. При этом причина ошибка записывается в поле state_info.

Поскольку у юридического лица может быть несколько торговых точек, то последняя регистрируемая назначается как торговая точка по умолчанию. Умолчание можно изменить, если использовать функцию установка Дефолтного мерчанта

Через параметр mode можно задать дополнительный режим регистрации, например, при mode=simple регистрируется только юридическое лицо, без торговой точки. А в режиме же mode=full происходит регистрация и юридического лица и торговой точки. Если параметр не задан, то по умолчанию считаем, что мы выполняем полную full регистрацию.

path Parameters
id
required
string

Идентификатор мерчанта

query Parameters
mode
string
Default: "Full"
Enum: "Full" "Simple"

Режим регистрации

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "shop_address": {
    },
  • "latitude": "string",
  • "longitude": "string",
  • "customer": {
    },
  • "category": "string",
  • "mcc": "string",
  • "phone": "string",
  • "zone_id": "string",
  • "externals": [
    ],
  • "default_merchant": true,
  • "registration_mode": "Full",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Дефолтный мерчант

Устанавливает для указанного мерчанта признак того, что он является мерчантом (торговой точкой) по умолчанию.

Торговая точки по умолчанию используется в том случае, если в каких-либо операциях нужно выбрать какую-нибудь торговую точку, не важно какую.

path Parameters
id
required
number

Идентификатор мерчанта

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "shop_address": {
    },
  • "latitude": "string",
  • "longitude": "string",
  • "customer": {
    },
  • "category": "string",
  • "mcc": "string",
  • "phone": "string",
  • "zone_id": "string",
  • "externals": [
    ],
  • "default_merchant": true,
  • "registration_mode": "Full",
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Commons

PING

Проверка работоспособности API-сервиса

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "[production]",
  • "build": "659",
  • "version": "dev-SNAPSHOT",
  • "time": "2023-01-17T14:05:18.288+00:00"
}

Справочник банков

Запрос справочника банков по типу кода банка:

  • LOCAL - запрос банков страны текущего провайдера
  • SWIFT - запрос банков, подключенных к SWIFT
  • PROVIDER - запрос партнерских банков, если такие определены у текущего провайдера.
  • FASTPAY - запрос банков, которые зарегистрированы в местной системе быстрых платежей.
Authorizations:
Commons_Authorization
query Parameters
type
required
string
Enum: "LOCAL" "SWIFT" "PROVIDER" "FASTPAY"

Тип кода банка

page
integer
Default: 0

Номер страницы

per_page
number
Default: 10

Количество элементов на страницу

acct_types
string
Default: "CRSA"
Enum: "CRSA" "UTRA" "TRSA" "CLAC" "BANA" "TRUA" "CBRA"
Example: acct_types=CRSA

Типы счетов (через запятую)

code
string

Часть кода или имени банка

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Справочник заданного типа

Справочники нужны для заполнения данных, например, анкеты юридического лица, где используются справочник организационно правовых форм (CORPORATE_TYPES) или справочник видов деятельности (INDUSTRY_CODES)

Authorizations:
Commons_Authorization
path Parameters
type
required
string

Тип справочника (например, CORPORATE_TYPES или INDUSTRY_CODES)

query Parameters
per_page
integer
Default: 10

Количество записей на страницу

page
string
Default: "0"

Текущая запрашиваемая страница

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Доступные валюты

Возвращает список валют, которые определены или доступны для текущего приложения (провайдера). При создании транзакции или открытии счетов необходимо использовать идентификатор валюты (asset_id), который возвращен данным справочником.

Authorizations:
Commons_Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Текущий пользователь

Возвращает данные о текущем авторизованном пользователей - идентификатор пользователя, текущие роли, перечень авторизованных клиентов и другую информацию.

В поле auth_channel указывает способ аутентификации, который был использован:

  • SMS - доп. аутентификация сделана через SMS код.
  • APP - доп. аутентификация сделана через внешнее приложение-аутентификатор
  • CERTIFICATE - вход был осуществлен по сертификату (доп. аутентификация, как правило, не требуется)
  • PWD - вход был осуществлен только по логину/паролю (может быть ограничение функционала)
Authorizations:
Commons_Authorization

Responses

Response samples

Content type
application/json
{
  • "auth_channel": "SMS",
  • "login": "string",
  • "name": "string",
  • "locale_id": "ru_RU",
  • "roles": [
    ],
  • "customers": [
    ],
  • "customer": 0,
  • "client_id": "string",
  • "user_customer": 0
}

Текущие группы клиентов

Данный API позволяет получить группы клиентов по некоторой категории. Например, тарифные группы (тарифные планы).

Authorizations:
Commons_Authorization
query Parameters
category
required
string
Example: category=tariff

Категория группы

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "group_code": "string",
  • "category": "tariff",
  • "name": "string"
}

Лента событий

Возвращает список событий, произошедших в платформе, которые доступны для текущего провайдера.

Данное API требует админского доступа (тип приложения "provider" и присутствие в списке распорядителей текущего провайдера приложения).

События доступны для следующих объектов:

  • User (например, "Success" - успешная авторизация, "LoginError" - неуспешная)
  • Customer (например, "AddRelated" - добавлен распорядитель, "BlockedByBank" - заблокирован банком)
  • Contact (например, "AddContact" или "RemoveContact")
  • Transaction (например, события по смене статуса "Completed", "Confirmed", "Cancelled", "Registry" или ошибки "ValidationError", "ConfirmationError")
  • Account (например, "CreateAccount", "CloseAccount" или "AddBlockade")
  • Limit (например, "SetLimit" или "DeleteLimit")

Набор событий и объектов может варьироваться в зависимости от настроек проекта. Фильтровать события в выборке можно при помощи двух параметров: objects и events, задающих список объектов и типов событий соответственно.

Выборка событий должна быть всегда ограничена по времени, для чего используются два параметра:

  • start, задающий дату отсечения событий, например, start=2023-12-02 - выборка событий, начиная с этой даты.
  • timestamp, задаёт отсечение выборки событий, начиная с этой временной метки. Например, time=1720637323.568797000

Использовать timestamp удобно в ситуации, когда отслеживается появление новых событий. У каждого объекта в событиях всегда заполнен данный атрибут и можно его указывать, чтобы продолжить выборку с заданного события.

Использование параметра start удобно, если хочется периодически контролировать список событий, начиная с заданного дня. Важно! Дата start указывается с учетом временной зоны текущего провайдера, под которым работает инсталляция платформы. Например, если провайдер (например, банк) работает во временной зоне GMT+5, то события со временем генерации позже 19:00 UTC будут относиться к уже следующему дню.

При использовании timestamp сотировка событий в выборке всегда в порядке возрастания вне зависимости от значения параметра sort.

Authorizations:
Commons_Authorization
query Parameters
start
string <date>
Example: start=2023-12-02

Дата отсечения ленты событий

per_page
integer <int32> [ 1 .. 100 ]
Default: 10

Размер страницы в выборке

page
integer <int32> >= 0
Default: 0
Example: page=1

Номер текущей страницы

sort
string
Default: "-created"
Example: sort=+created

Сортировка по дате создания (created)

timestamp
string
Example: timestamp=1720637323.568797000

Метка времени (секунды + наносекунды)

objects
string

Список нужных объектов (через запятую)

events
string

Список нужных событий (через запятую)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ExternalEntities

Удаление внешнего ID

Удаляет связь между внешним идентификатором (из другой внешней системы) и собственным идентификатором объекта в Платформе.

Authorizations:
None
path Parameters
ext
required
string

Внешний идентификатор

type
required
string
Enum: "Account" "Customer" "User" "Card"

Тип объекта

id
required
string

Идентификатор объекта

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Удаление внешних ID

Удаляет все связи между внешним идентификатором (из другой внешней системы) и заданным типом объекта (например, User).

path Parameters
ext
required
string

Внешний идентификатор

type
required
string
Enum: "User" "Account" "Card" "Customer"

Тип объекта

Responses

Response samples

Content type
application/json
[
  • {
    }
]

История внешних ID

Возвращает список всех внешних идентификаторов, когда-либо ассоцированных с заданным объектом. В том числе отвязанных (статус = Inactive).

Authorizations:
None
path Parameters
id
required
string

Идентификатор объекта

type
required
string

Тип объекта

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Восстановление внешнего ID

Восстанавливает отвязанных внешний идентификатор, если он не был где-либо переиспользован.

Authorizations:
None
path Parameters
id
required
string

Идентификатор объекта ExternalEntity

Responses

Response samples

Content type
application/json
{
  • "external_id": "string",
  • "provider": {
    },
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Terraform

Список загрузок

Возвращает список всех заявок на загрузку данных.

Authorizations:
Terraform_API_Authorization
query Parameters
page
integer

Номер страницы

per_page
integer

Количество элементов на страницу

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Создание загрузки

Выполняет создание черновика новой загрузки.

Authorizations:
Terraform_API_Authorization
Request Body schema: application/json
title
required
string

Название заявки для её идентификации.

algorithm
required
string

Алгоритм обработки заявки. Выбирается из числа тех, которые поддерживаются конкретным проектом.

Array of objects (Terraform_API_DataLoaderItem)

Набор запросов

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "algorithm": "string",
  • "contents": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "string",
  • "algorithm": "string",
  • "contents": [
    ],
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Детали загрузки

Возвращает детали конкретной заявки на загрузку данных.

Authorizations:
Terraform_API_Authorization
path Parameters
id
required
integer

Идентификатор объекта

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "algorithm": "string",
  • "contents": [
    ],
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Правка загрузки

Корректирует заявку на загрузку на основании новых данных. Корректировка возможна в случае если заявка находится в состоянии: New, Draft или Verified.

Authorizations:
Terraform_API_Authorization
path Parameters
id
required
integer

Идентификатор объекта

Request Body schema: application/json
title
required
string

Название заявки для её идентификации.

algorithm
required
string

Алгоритм обработки заявки. Выбирается из числа тех, которые поддерживаются конкретным проектом.

Array of objects (Terraform_API_DataLoaderItem)

Набор запросов

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "algorithm": "string",
  • "contents": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "string",
  • "algorithm": "string",
  • "contents": [
    ],
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Удаление загрузки

Удаляет черновик заявки на загрузку. Удаление возможно для состояний: New, Draft или Verified.

Authorizations:
Terraform_API_Authorization
path Parameters
id
required
integer

Идентификатор объекта

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "error_id": "string",
  • "attrs": {
    }
}

Исполнение заявки

Отправляется заявку на исполнение, предварительно валидируя её.

Authorizations:
Terraform_API_Authorization
path Parameters
id
required
integer

Идентификатор заявки на загрузки

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "algorithm": "string",
  • "contents": [
    ],
  • "id": 12345,
  • "created": "2022-12-07T14:01:59.515+00:00",
  • "modified": "2022-12-11T07:00:55.567+00:00",
  • "state": "string",
  • "state_info": "string",
  • "state_changed": "2022-12-07T14:03:32.659+00:00"
}

Конверсия в демо

Преобразует заданного клиента в демо-клиента. Конверсия в демо-клиента для физических лиц меняется процедура входа - все PIN-коды и OTP-кодики отныне могут принимать значение только "1234".

В целом после преобразования в демо все транзакции клиентов фактически помечаются как исполненные, но в реальности не создают никаких проводок по счетам.

Использование демо-клиентов может быть удобно в автоматических интеграционных тестах, чтобы исключить необходимость отправки кодиков по внешним каналам. Также демо-пользователи подходят для безопасной передачи эккаунта внешним контрагентам, например, при модерации в AppStore/Google Play.

Authorizations:
Terraform_API_Authorization
path Parameters
id
required
integer

Идентификатор клиента

Responses

Reports

Данные по отчету

Authorizations:
NoneReports_API_Authorization
path Parameters
reportId
required
string

Идентификатор отчета

query Parameters
page
integer

Текущая страница

per_page
integer

Количество записей на страницу

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Данные по отчету в CSV

Возвращает отчет, но в формате CSV.

Authorizations:
NoneReports_API_Authorization
path Parameters
reportId
required
string

Идентификатор отчета

query Parameters
page
integer

Текущая страница

per_page
integer

Количество записей на страницу

Responses

Response samples

Content type
text/plain
cnt,customer_kind,state 1,Organization,Active