Платежное поручение
Тип документа предназначен для перевода сумм в тенге со счета Клиента на счет резидента РК.
Получение допустимых значений для платежного поручения
Не является обязательным к использованию. Предназначен для удобства использования API по созданию и редактированию документа.
| endpoint | /api/payment/domestic-transfer/source-field |
|---|---|
| Параметры строки запроса / Query String Parameters | fieldList=ACCOUNTS%2CCOUNTERPARTIES%2CKBE%2CLOCAL_BANKS%2CPAYMENT_DATES%2CKNP%2CKVO%2CPURPOSES%2CTEMPLATES%2CCONSTRAINTS%2CKBK_FOR_VIN%2CSUBSIDIARY_CUSTOMER%2CCUSTOMER%2CDOCUMENT_NUMBER%2CCOMPANY_PERSONS%2CKBK |
| Параметры строки запроса / Query String Parameters | domesticTransferType=PaymentOrder |
| Request method | GET |
| Response status | 200 |
разделитель для параметра fieldList – encoded - %2C; decoded – , (запятая).
Дополнительные заголовки / Additional headers
| Content-Type | application/json |
Ответ / Response object
!Важно: В таблице описания ответа, в графе “Примечание” описано значение и приведен связанный атрибут отправляемого объекта при создании или редактировании документа.
Описание структур объектов ответа приведено в разделе ДЕНЕЖНЫЕ ОПЕРАЦИИ > Описание объектов допустимых значений далее в данном руководстве.
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 1 | ACCOUNTS | array of objects | Счета клиента национальной валюте (тенге). Соответствующий атрибут - account |
| 2 | COMPANY_PERSONS | array of arrays | Массив фиксированной длинны = 2. Для первого элемента – список лиц с правом первой подписи. Соответствующий атрибут – director. Для первого элемента – список лиц с правом второй подписи. Соответствующий атрибут - accountant |
| 3 | CONSTRAINTS | object | Список параметров для валидации атрибутов отправляемого объекта при создании или редактирования документа |
| 4 | COUNTERPARTIES | array of objects | Список бенефициаров, которым ранее осуществлялись платежи |
| 5 | CUSTOMER | object | Данные Компании-клиента (customer) |
| 6 | DOCUMENT_NUMBER | string | Возможный следующий номер создаваемого документа |
| 7 | KBE | array of objects | КБЕ бенефициара. Соответствующий атрибут - benefResidencyCode |
| 8 | KBK | array of objects | КБК |
| 9 | KBK_FOR_VIN | string | |
| 10 | KNP | array of objects | КНП |
| 11 | KVO | array of objects | Код валютной операции. Соответствующий атрибут – kvo = code |
| 12 | LOCAL_BANKS | array of objects | Список банков РК |
| 13 | PURPOSES | array of strings | Список ранее используемых назначений платежа. Соответствующий атрибут – purpose |
| 14 | SUBSIDIARY_CUSTOMER | array of objects | Список дочерних организаций Компании-клиента |
| 15 | TEMPLATES | array of objects | Список шаблонов документа |
Создание платежного поручения
| endpoint | /api/payment/domestic-transfer/new |
| Request method | POST |
| Response status | 200 |
Дополнительные заголовки / Additional headers
| Content-Type | application/json |
Тело запроса / Body
!ВАЖНО: в примечаниях постоянные значения в рамках текущего запроса выделяются цветом.
| № | Поле | Тип данных | Является обязательным | Примечание |
|---|---|---|---|---|
| 1 | account | object | Да | AccountShortView – описание в таблице далее |
| 2 | amount | decimal | Да | Сумма перевода. Формат – "########.##" |
| 3 | valueDate | date | Да | Дата документа. Формат - "dd.MM.yyyy" |
| 4 | purpose | string | Да | Назначение |
| 5 | purposeCode | string | Да | Код КНП |
| 6 | purposeText | string | Да | Составное назначение платежа. purpose + КНП |
| 7 | priority | boolean | Да | Срочный платеж (false) |
| 8 | number | string | Да | Номер платежного документа. Не более 9 знаков. |
| 9 | isTemplate | boolean | Да | false |
| 10 | director | object | Да | CustomerUserShortView – описание в таблице далее |
| 11 | accountant | object | Да | CustomerUserShortView – описание в таблице далее |
| 12 | benefName | string | Да | Наименование бенефициара |
| 13 | benefTaxCode | string | Да | БИН бенефициара |
| 14 | benefAccount | string | Да | Счет бенефициара |
| 15 | benefBankCode | string | Да | Код банка бенефициара |
| 16 | benefResidencyCode | string | Да | Код резидента бенефициара |
| 17 | vat | decimal | Сумма НДС. Формат – "########.##" | |
| 18 | budgetCode | number | ||
| 19 | vinCode | long | null | |
| 20 | domesticTransferType | string | Да | "PaymentOrder" – подтип документа |
| 21 | isNotNeedUnc | boolean | Да | false |
| 22 | isNotLinkTerrorism | boolean | Да | true |
| 23 | isPermitGiveInformation | boolean | Да | false |
| 24 | isLoanPay | boolean | Да | За счет кредитных средств |
| 25 | isSubsidiaryOrganization | boolean | Да | false |
| 26 | numberOfAdministrativeAffairs | string | "" | |
| 27 | isRaw | boolean | Да | Признак для черновика (false) |
| 28 | kvo | string | Да | Код валютной операции |
| 29 | customPaymentData | object | ||
| 30 | custTaxCode | string | ||
| 31 | senderResidencyCountryCode | string | Да | Страна резидентства отправителя в двузначном варианте |
| 32 | benefResidencyCountryCode | string | Да | Страна резидентства получателя в двузначном варианте |
| 33 | actualSender | object | Нет | Фактический отправитель |
| 34 | actualBeneficiary | object | Нет | Фактический получатель |
| 35 | templateName | string | null |
Object: account (AccountShortView)
| № | Поле | Тип данных | Является обязательным | Примечание |
|---|---|---|---|---|
| 1 | id | long | Да | Идентификатор в Системе |
| 2 | number | string | Да | Номер счета |
| 3 | cardNumber | string | ||
| 4 | currency | string | Валюта | |
| 5 | currencyDigital | long | ||
| 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 – описание в таблице в разделе ДЕНЕЖНЫЕ ОПЕРАЦИИ > Описание базового объекта (PaymentView) | |
| 14 | gk |
Object: director, account (CustomerUserShortView)
| № | Поле | Тип данных | Является обязательным | Примечание |
|---|---|---|---|---|
| 1 | id | long | Да | Идентификатор в Системе |
| 2 | fullName | string | Да | ФИО |
| 3 | position | string | Должность | |
| 4 | sign_level | string | Да | Уровень права подписи |
Object: actualSender, actualBeneficiary (ActualSubject)
| № | Поле | Тип данных | Является обязательным | Примечание |
|---|---|---|---|---|
| 1 | taxCode | string | Да | ИИН/БИН |
| 2 | name | string | Да | Наименование |
Ответ / Response object
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 1 | value | long | Идентификатор созданного в Системе документа id |
Пример запроса
Показать запрос
curl --location \
'https://api-test.berekebank.kz/api/payment/domestic-transfer/new' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json' \
--data-raw '{"account":{"id":11111,"number":"K111111111KZ11TC","currency":"KZT","currencyCode":111,"currencyName":"тенге","currencyDigitCode":"111","amount":0},"recipient":{"id":11111,"name":"Иванов Иван Иванович","accountNumber":"KZ00000KZT0000000004","bankCode":"KZ1BPSBK","bankName":"АО \"Bereke Bank\"","bankBic":"SBPKKZKA","bankCity":"г. Алматы","bankCorrAccount":"KZ00000KZT0000000004","bankCountry":"KZ","bankSwiftCode":"SBPKKZKA"},"docNumber":"11111111","docDate":"2025-06-27T12:50:40.572Z","amount":1,"currency":"KZT","paymentCode":"1111","paymentCodeName":"Текущий платеж","paymentName":"Текущий платеж","purpose":"Списание","recipientBankBic":"SBPKKZKA","recipientBankName":"АО \"Bereke Bank\"","customer":{"id":111111,"name":"АО «Bereke Bank»","shortName":"АО «Bereke Bank»","iin":"210840000011"},"referenceNumber":"210840000011","paymentType":"INTERNAL_TRANSFER","paymentTypeName":"Внутренний перевод","beneficiary":{"id":111111,"name":"Иванов Иван Иванович","iin":"210840000011"},"exchangeRate":1,"currencyRate":1,"currencyRateNominal":1,"exchangeRateNominal":1,"confirmed":false,"fxTransactionId":null,"commission":0,"commissionCurrency":"KZT","commissionCurrencyCode":111,"commissionAmount":0,"commissionPercent":0,"custTaxCode":"210840000011"}'
Пример ответа
Показать ответ
{
"lastName": "Фамилию можно пропустить, создаем документ!",
"value": 11111111
}
Редактирование платежного поручения
Редактирование платежного поручения доступно только для документов с активным статусом Черновик (Raw) или Новый (Draft).
| endpoint | /api/payment/domestic-transfer/{id} |
| Request method | POST |
| Response status | 200 |
id – идентификатор созданного в Системе документа.
Дополнительные заголовки / Additional headers
| Content-Type | application/json |
Тело запроса / Body
Смотреть Создание платежного поручения > Тело запроса / Body
Ответ / Response object
| № | Поле | Тип данных | Примечание |
|---|---|---|---|
| 1 | value | long | Идентификатор отредактированного в Системе документа id |