Денежные операции
В Системы реализует методы для создания и отправки на исполнение в Банк финансовых документов. Общий процесс состоит из следующих шагов:
| № | Шаг | Статус-результат | Результат |
|---|---|---|---|
| 1.1 | Создание документа как черновика | Черновик (Raw) | Необязательный шаг. Указать isRaw = true в теле запроса. Документ не проходит валидацию. |
| Для перевода в статус «Новый»: | |||
| 1. Заполнить все обязательные поля. | |||
| 2. Успешная валидация. | |||
3. isRaw = false при сохранении. | |||
| 1.2 | Создание нового документа | Новый (Draft) | Проходит валидацию. При ошибке — возврат соответствующей ошибки. |
| 2 | На подпись | Ожидает подписание (AwaitsSignature) | Перевод в статус «На подпись». Доступна подпись документа. |
| 3 | Подписание | Ожидает отправки (Signed) | Процедура подписания с ЭЦП. |
| 4 | Отправка в Банк | Принят (SentToRBS) | Обработка в системах Банка. Дата валютирования = текущей дате. |
| 5 | Обработка в Банке | Принят в АБС / Отказ от АБС | Действий не требуется. |
Для каждого типа документов реализованы собственные подразделы API:
| № | Вид документа | Базовый путь | Объект | Базовый объект |
|---|---|---|---|---|
| 1 | Переводы в тенге | api/payment/domestic-transfer | DomesticTransferView | PaymentView |
| 2 | Переводы в валюте | api/payment/international-transfer | InternationalTransferView | PaymentView |
| 3 | Конвертация | api/payment/account-transfer | AccountTransferView | PaymentView |
Описание базового объекта PaymentView
Объект CommonView
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 1 | id | long | Идентификатор документа в Системе |
| 2 | externalId | string | Внешний идентификатор |
| 3 | code | string | Код в Системе |
| 4 | description | string | Примечание |
Объект DocumentView
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 5 | custId | long | Customer: Идентификатор |
| 6 | custExternalId | string | Customer: Внешний ID |
| 7 | custName | string | Customer: Наименование |
| 8 | custTaxCode | string | Customer: БИН |
| 9 | custResidencyCode | string | Customer: КБЕ |
| 10 | created | datetime | Дата создания ("dd.MM.yyyy") |
| 11 | number | string | Номер (до 9 знаков) |
| 12 | state | string | Статус документа |
| 13 | stateLabel | string | Расшифровка статуса |
| 14 | type | string | Тип документа |
| 15 | director | object | Customer: директор (см. ниже) |
| 16 | accountant | object | Customer: бухгалтер (см. ниже) |
| 17 | bankResponse | string | |
| 18 | manager | string | |
| 19 | info | string | |
| 20 | isTemplate | boolean | Признак шаблона |
| 21 | templateName | string | Название шаблона |
| 22 | receiveDateTime | datetime | |
| 23 | channel | string | Канал создания |
Объект PaymentView
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 24 | account | object | Customer: счет в системе (AccountShortView) |
| 25 | custBankCode | string | Customer: код банка, например "BRKEKZKA" |
| 26 | custBankName | string | Customer: наименование банка |
| 27 | amount | decimal | Сумма |
| 28 | valueDate | datetime | Дата документа (формат: "dd.MM.yyyy") |
| 29 | purpose | string | Назначение |
| 30 | purposeCode | string | Код КНП |
| 31 | purposeCodeLabel | string | Расшифровка КНП |
| 32 | purposeText | string | Составное назначение: purpose + КНП |
| 33 | priority | boolean | Срочный платеж |
| 34 | benefName | string | Бенефициар: наименование организации |
| 35 | benefTaxCode | string | Бенефициар: БИН |
| 36 | benefAccount | string | Бенефициар: номер банковского счета |
| 37 | benefCard | string | Бенефициар: номер карты (если есть) |
| 38 | benefBankCode | string | Бенефициар: код банка |
| 39 | benefBankName | string | Бенефициар: наименование банка |
| 40 | benefResidencyCode | string | Бенефициар: КБЕ |
| 41 | commission | string | Комиссия |
| 42 | actions | object | Доступные действия для документа в текущем состоянии |
| 43 | isNotNeedUnc | boolean | |
| 44 | isNotLinkTerrorism | boolean | |
| 45 | isPermitGiveInformation | boolean | |
| 46 | isRaw | boolean | Признак шаблона |
| 47 | benefResidencyCountryCode | string | Страна резидентства получателя (двузначный код) |
| 48 | senderResidencyCountryCode | string | Страна резидентства отправителя (двузначный код) |
| 49 | actualSender | object | Фактический отправитель (ActualSubject) |
| 50 | actualBeneficiary | object | Фактический получатель (ActualSubject) |
Объект CustomerUserShortView (используется в director/accountant)
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 1 | id | long | Идентификатор в системе |
| 2 | fullName | string | ФИО |
| 3 | position | string | Должность |
| 4 | signLevel | string | Уровень подписи |
Объект AccountShortView
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 1 | id | long | Идентификатор |
| 2 | number | string | Номер счета |
| 3 | cardNumber | string | |
| 4 | currency | string | Валюта |
| 5 | currencyDigital | string | |
| 6 | balance | decimal | Текущий баланс |
| 7 | plannedBalance | decimal | |
| 8 | alias | string | |
| 9 | externalCustomerId | string | |
| 10 | type | string | |
| 11 | accountType | string | |
| 12 | expirationDate | datetime | |
| 13 | status | object | CodeDto — см. ниже |
Объект CodeDto (статус счета)
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 1 | id | long | Идентификатор |
| 2 | code | string | |
| 3 | label | string | Локализованное название |
| 4 | subCode | string | |
| 5 | subLabel | string |
Объект ActualSubject (actualSender / actualBeneficiary)
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 1 | taxCode | string | ИИН/БИН |
| 2 | name | string | Наименование |
О допустимых значениях
Для удобства работы с Сервисом, при создании или редактировании документа в соответствующих подразделах API, реализованы методы получения допустимых значений для атрибутов создаваемого или редактируемого документа.
Далее, в руководстве перед описанием метода создания / редактирования документа, описывается метод получения и объекты соответствующих допустимых значений.
С подробным описанием структур объектов можно ознакомиться в разделе ДЕНЕЖНЫЕ ОПЕРАЦИИ > Описание объектов
Примечание: Не является обязательным к использованию.