По любому вопросу мы в одном клике

Задать вопрос

Введение

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

В процессе выплат участвуют следующие стороны:

Общий процесс взаимодействия с использованием только API вызовов (для работы с реквизитами получателя может потребоваться сертификация PCI DSS):

  1. Получатель обращается к Оператору Партнера или самостоятельно в Сервис Партнера за получением Выплаты;
  2. При получении обращения Сервис Партнера осуществляет сбор платежных реквизитов Получателя;
  3. Сервис Партнера регистрирует проведение Выплаты в МВ и подтверждает Выплату;
  4. Производится Выплата и возврат результата проведения Выплаты;
  5. Сервис Партнера может запросить статус Выплаты в любой момент.

Общий процесс взаимодействия с использованием API вызовов и страниц Банка (страница сбора реквизитов получателя, финишная страница):

  1. Получатель обращается к Оператору Партнера или самостоятельно в Сервис Партнера за получением Выплаты;
  2. При получении обращения Сервис Партнера регистрирует проведение выплаты в МВ;
  3. Сервис Партнера получает адрес страницы сбора реквизитов Получателя для ввода платежных реквизитов Получателя для отображения Оператору или Получателю;
  4. Страница сбора реквизитов Получателя осуществляет сбор платежных реквизитов Получателя и подтверждение Выплаты;
  5. Производится Выплата и возврат результата проведения Выплаты;
  6. Сервис Партнера может запросить статус Выплаты в любой момент.

Выплата денежных средств с транзитного счета Партнера, для этого необходимо поддержать следующие сценарии выплаты:

Выплата денежных средств с корпоративной карты Партнера, для этого необходимо поддержать следующие сценарии выплаты:

Особенности реализации и ограничения

  1. Отмены и возвраты ранее выполненных выплат не поддерживаются;
  2. Поддерживаются выплаты только в валюте с кодом 398 (KZT);
  3. Выплаты осуществляются только на карты банков Казахстана.

Сценарии работы

Запрос баланса выплат через API

Данный сценарий описывает последовательность действий по запросу баланса выплат с использованием API.

sequenceDiagram participant O as Оператор participant PS as Сервис Партнера participant PM as Модуль выплат autonumber O->>PS: Инициация запроса баланса activate O activate PS PS->>PM: Запрос на получение баланса
(getAmount.do) activate PM PM->>PM: Проверка данных запроса,
сбор данных по балансу PM-->>PS: Ответ с данными
о балансе deactivate PM PS-->>O: Отображение баланса deactivate PS deactivate O
  1. Оператор принимает решение о запросе баланса по выплатам и выполняет на стороне Сервиса Партнера необходимые действия;
  2. Сервис Партнера отправляет запрос баланса (getAmount.do) в Модуль Выплат;
  3. Входная проверка данных, формирование информации о балансе выплат;
  4. Модуль Выплат возвращает в Сервис Партнера данные о балансе;
  5. Сервис Партнера отображает Оператору информацию о балансе.

Выплата денежных средств только через API

Данный сценарий описывает последовательность выплаты из сервиса партнера с использованием API. Сбор реквизитов Получателя реализуется на стороне Партнера (для работы с реквизитами получателя может потребоваться сертификация PCI DSS).

sequenceDiagram participant O as Оператор participant PS as Сервис Партнера participant PM as Модуль выплат autonumber O->>PS: Инициация выплаты activate O activate PS PS->>PM: Запрос на осуществление выплаты
(performPayout.do) activate PM PM->>PM: Проверка данных запроса,
выполнение регистрационных
и платежных операций PM-->>PS: Ответ с результатом
осуществления выплаты deactivate PM PS-->>O: Статус выплаты deactivate PS deactivate O
  1. Оператор (или Получатель) принимает решение о проведении выплаты и выполняет на стороне Сервиса Партнера необходимые действия;
  2. Сервис Партнера отправляет запрос на осуществление выплаты (performPayout.do) в Модуль Выплат и передает все необходимые параметры выплаты;
  3. Входная проверка данных, выполнение регистрационных и платежных операций;
  4. Модуль Выплат возвращает в Сервис Партнера итоговый статус выплаты;
  5. Сервис Партнера уведомляет Оператора (или Получателя) о статусе выплаты.

Выплата денежных средств через API и страницы выплат Банка

Данный сценарий описывает последовательность выплаты из сервиса партнера с использованием API и страницы выплат Банка. Сбор карточных данных Получателя реализуется с использованием страницы на стороне Банка (для этого не требуется сертификация PCI DSS).

sequenceDiagram participant O as Оператор participant PS as Сервис Партнера participant PM as Модуль выплат autonumber O->>+PS: Инициация выплаты activate O PS->>+PM: Запрос на регистрацию выплаты
(registerPayout.do) PM->PM: Регистрация выплаты PM-->>-PS: URL страницы для указания
реквизитов Получателя PS-->>-O: URL страницы для указания
реквизитов Получателя O->>+PM: Открытие страницы
Заполнение реквизитов Получателя
Подтвержение выплаты PM->PM: Выполнение выплаты PM-->>-O: Редирект на финишную страницу O->>+PM: Загрузка финишной страницы,
запрос результата выплаты activate PM PM->>PM: Формирование статуса PM-->>O: Результат осуществлении выплаты deactivate PM deactivate O
  1. Оператор (или Получатель) принимает решение о проведении выплат и выполняет на стороне Сервиса Партнера необходимые действия;
  2. Сервис Партнера отправляет в Модуль Выплат запрос на регистрацию выплаты (registerPayout.do) и передает все необходимые параметры для регистрации;
  3. Модуль Выплат регистрирует выплату;
  4. Модуль Выплат возвращает URL страницы (в ссылке присутствует уникальный идентификатор выплаты);
  5. Сервис Партнера перенаправляет Оператора (или Получателя) на полученный URL страницы;
  6. Оператор (или Получатель) переходит на страницу, заполняет реквизиты Получателя и подтверждает выплату;
  7. Модуль Выплат выполняет выплату;
  8. Модуль Выплат возвращает URL страницы (в ссылке присутствует уникальный идентификатор выплаты);
  9. Оператор (или Получатель) переходит на страницу, и инициирует получение статуса;
  10. Модуль Выплат формирует статус;
  11. Модуль Выплат показывает статус на странице.

Запрос статуса выплаты

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

sequenceDiagram participant O as Оператор/Получатель participant PS as Сервис Партнера participant PM as Модуль выплат autonumber O->>PS: Запрос Статуса выплаты activate O activate PS PS->>PM: Запрос результата выплаты
(getPayoutStatus.do) activate PM PM->>PM: Проверка данных запроса
и формирование ответа PM-->>PS: Ответ с результатом
проведения выплаты deactivate PM PS-->>O: Результат статуса выплаты deactivate PS deactivate O
  1. Оператор (или Получатель) запрашивает статус выплаты в Сервисе Партнера;
  2. Сервис Партнера отправляет в Модуль Выплат запрос статуса выплаты (getPayoutStatus.do);
  3. Модуль Выплат проверяет данные запроса и формирует ответ;
  4. Модуль Выплат возвращает в Сервис Партнера итоговый статус выплат;
  5. Сервис Партнера уведомляет Оператора (или Получателя) о статусе выплаты.

API запросы для выплат

Запросы осуществляются с использованием протокола HTTP 1.1 с использованием SSL (HTTPS), на адрес:

TEST: https://3dsec.berekebank.kz/payouts/api/{api_version}/{api_method}
PROD: https://securepayments.berekebank.kz/payouts/api/{api_version}/{api_method}

HTTPS POST API запросы должны отвечать следующим требованиям:

HTTPS POST API запросы должны содержать заголовки:

Актуальная версия API для указания в контексте запроса ({api_version}): v2

Требования безопасности

Запрос проверки доступности Модуля Выплат

Для проверки работоспособности Модуля Выплат необходимо использовать HTTPS GET API запрос /payouts/api/v2/echo

Параметры запроса

Параметры не требуются.

Параметры ответа

Ответ предоставляется в формате text/plain. В ответе указывается текущая версия модуля выплат и имя ноды через дефис, в квадратных скобках указано имя инстанса.

Пример запроса

curl --location 'https://3dsec.berekebank.kz/payouts/api/v2/echo'

Пример ответа

Payout v2.3 is online in channel Payout_APIserver - svip01[instance:svipUAT]

Запрос баланса

Для запроса остатка баланса для выплат необходимо использовать HTTPS POST API запрос /payouts/api/v2/getAmount.do. Данный запрос возвращает данные об остатке баланса при условии успешной обработки запроса.

Параметры запроса

Обязательность Параметр Тип Описание
Обязательно userName String [30] Логин Партнера, полученный при подключении
Обязательно password String [30] Пароль Партнера, полученный при подключении
Условие source Object Объект для передачи информации о реквизитах источника средств. Указывается только при использовании типа фондирования "Выплата денежных средств с корпоративной карты Партнера"
Условие source.bindingId String Идентификатор связки, по реквизитам которой должно быть списание денежных средств (получить идентификатор можно в специальном разделе Личного кабинета)

Параметры ответа

Обязательность Параметр Тип Описание
Обязательно errorCode String Код ошибки обработки запроса
Условие errorMessage String [512] Описание ошибки
Условие balanceDescriptionList Object Объект для передачи информации об остатке
Условие balanceDescriptionList.balanceSign String Тип доступного остатка. Возможные значения:
  • C - положительный доступный остаток;
  • D - отрицательный доступный остаток.
Условие balanceDescriptionList.balanceAmount Integer Сумма доступного остатка денежных средств в минимальных единицах валюты
Условие balanceDescriptionList.balanceCurrency String Код валюты доступного остатка (ISO 4217)
Необязательно balanceDescriptionList.balanceDescription String Описание доступного остатка

Пример запроса

curl --location 'https://3dsec.berekebank.kz/payouts/api/v2/getAmount.do' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userName": "payout_api_username",
    "password": "payout_api_password",
    "source": {
      "bindingId": "4908a3c3-6c7c-75d3-9707-66ab06c12040"
    }
}'

Пример ответа

{
    "errorCode": "0",
    "balanceDescriptionList": {
        "balanceAmount": 49925200,
        "balanceCurrency": "398",
        "balanceSign": "C"
    }
}

Регистрация выплаты

Для регистрации выплаты необходимо использовать HTTPS POST API запрос /payouts/api/v2/registerPayout.do. Данный запрос осуществляет регистрацию Выплаты и возвращает ссылку на страницу указания реквизитов Получателя. Сбор реквизитов получателя реализуется на стороне Банка (для работы с реквизитами получателя не требуется сертификация PCI DSS).

Параметры запроса

Обязательность Параметр Тип Описание
Обязательно userName String [30] Логин Партнера, полученный при подключении
Обязательно password String [30] Пароль Партнера, полученный при подключении
Обязательно

orderNumber String Уникальный номер заказа в шлюзе.
  • отсутствует для выплат с типом CREDIT_ONLY и P2P_TRANSFER, т.к. совпадает с одноименным параметром в основном блоке;
  • присутствует для выплат с типом DEBIT_CREDIT и содержит номер заказа в шлюзе, над которым выполнялась операция.
    Обязательно amount Integer [12] Сумма выплаты в минимальных единицах валюты
    Обязательно

    currency String Код валюты платежа в соответствии с ISO 4217
    Необязательно description String [598] Описание выплаты в свободной форме
    Необязательно language String [2] Ключ языка по ISO 639-1. Если язык не указан, используется язык по умолчанию
    Условие client Object Объект для передачи информации о Получателе выплаты
    Условие client.clientId String [30] Номер (идентификатор) клиента в системе Партнера. Требуется передавать для использования функционала связок
    Необязательно client.email String [30] Адрес электронной почты Получателя
    Необязательно client.phone String [15] Номер телефона Получателя в международном формате (9991234567)
    Обязательно client.name String [24] Имя Получателя латиницей
    Необязательно sessionTimeoutSecs Integer Продолжительность жизни заказа на Выплату в секундах. В случае если параметр не задан, будет использовано значение по умолчанию (1200 секунд)
    Условие urls Object Объект для передачи информации об используемых URL
    Обязательно urls.returnUrl String Адрес, на который требуется перенаправить Оператора (или Получателя) в случае успешной Выплаты. Адрес должен быть указан полностью, включая протокол
    Необязательно urls.failUrl String Адрес, на который требуется перенаправить Оператора (или Получателя) в случае неуспешной Выплаты. Адрес должен быть указан полностью, включая протокол
    Необязательно jsonParams Object Объект для передачи дополнительной информации по выплате для последующего хранения. Передаются в виде: {"name1":"value1", ... ,"nameN":"valueN"}
    Необязательно jsonParams.$name String Дополнительный параметр со свободным названием

    Параметры ответа

    Обязательность Параметр Тип Описание
    Обязательно errorCode String Код ошибки обработки запроса
    Условие errorMessage String [512] Описание ошибки
    Условие formUrl String URL статической платежной страницы, на который надо перенаправить браузер клиента. Отсутствует, если регистрация заказа на Выплату не удалась по причине ошибки, указанной в errorCode
    Условие orderId String Уникальный идентификатор заказа на Выплату. Отсутствует, если регистрация заказа на Выплату не удалась по причине ошибки, указанной в errorCode
    Условие orderNumber String Идентификатор заказа на Выплату в системе Партнера. Копируется из запроса

    Пример запроса

    curl --location 'https://3dsec.berekebank.kz/payouts/api/v2/registerPayout.do' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "userName": "payout_api_username",
        "password": "payout_api_password",
        "orderNumber": "1645458818047",
        "amount": 1234,
        "currency": "398",
        "description": "Decent payout",
        "language": "EN",
        "client": {
            "clientId": "12345abc-d67e-8901-23fg-h45i67jk8901",
            "email": "payee@mail.com",
            "phone": "9991234567"
        },
        "urls": {
            "returnUrl": "https://partnerdomain.com/&result=ok",
            "failUrl": "https://partnerdomain.com/&result=ok",
        },
        "sessionTimeoutSecs": 300,
        "jsonParams": {
            "paramname1": "paramvalue1",
            "paramname2": "paramvalue2"
        }
    }'
    

    Пример ответа

    {
        "errorCode": "0",
        "orderNumber": "1645458818047",
        "orderId": "da42b8d9-328b-45e6-aa35-235e348268bf",
        "formUrl": "https://payoutdomain.com/payment/merchants/svip_payout_ab/payment_ru.html?mdOrder=da42b8d9-328b-45e6-aa35-235e348268bf"
    }
    

    Проведение выплаты

    Для проведения выплаты необходимо использовать HTTPS POST API запрос /payouts/api/v2/performPayout.do.
    Данный запрос осуществляет связанную отработку Выплаты и возвращает статус.
    Сбор реквизитов Получателя реализуется на стороне Партнера (для работы с реквизитами получателя требуется сертификация PCI DSS).

    Параметры запроса

    Обязательность Параметр Тип Описание
    Обязательно userName String [30] Логин Партнера, полученный при подключении
    Обязательно password String [30] Пароль Партнера, полученный при подключении
    Обязательно

    orderNumber String Уникальный номер заказа в шлюзе.
    • отсутствует для выплат с типом CREDIT_ONLY и P2P_TRANSFER, т.к. совпадает с одноименным параметром в основном блоке;
    • присутствует для выплат с типом DEBIT_CREDIT и содержит номер заказа в шлюзе, над которым выполнялась операция.
      Обязательно amount Integer [12] Сумма выплаты в минимальных единицах валюты
      Обязательно

      currency String Код валюты платежа в соответствии с ISO 4217
      Необязательно description String [598] Описание выплаты в свободной форме
      Необязательно language String [2] Ключ языка по ISO 639-1. Если язык не указан, используется язык по умолчанию
      Условие client Object Объект для передачи информации о Получателе выплаты
      Условие client.clientId String [30] Номер (идентификатор) клиента в системе Партнера. Требуется передавать для использования функционала связок
      Необязательно client.email String [30] Адрес электронной почты Получателя
      Необязательно client.phone String [15] Номер телефона Получателя в международном формате (9991234567)
      Обязательно client.name String [24] Имя Получателя латиницей
      Условие source Object Объект для передачи информации о реквизитах источника средств. Указывается только при использовании типа фондирования "Выплата денежных средств с корпоративной карты Партнера"
      Условие source.bindingId String Идентификатор связки, по реквизитам которой должно быть списание денежных средств (получить идентификатор можно в специальном разделе Личного кабинета)
      Условие target Object Объект для передачи информации о реквизитах получателя средств. По согласованию данный блок может отсутствовать
      Условие target.bindingId String Идентификатор связки, по реквизитам которой должно быть зачисление денежных средств. Указывается либо данные карты (pan), либо идентификатор связки (bindingId)
      Условие target.card.pan String Номер карты зачисления денежных средств. Указывается либо данные карты (pan), либо идентификатор связки (bindingId)
      Необязательно jsonParams Object Объект для передачи дополнительной информации по выплате для последующего хранения. Передаются в виде: {"name1":"value1", ... ,"nameN":"valueN"}
      Необязательно jsonParams.$name String Дополнительный параметр со свободным названием

      Параметры ответа

      Обязательность Параметр Тип Описание
      Обязательно amount Integer [12] Сумма выплаты в минимальных единицах валюты
      Необязательно fee Integer [12] Сумма комиссии в минимальных единицах валюты
      Обязательно

      currency String Код валюты платежа в соответствии с ISO 4217
      Условие creationDate Integer Дата и время создания (регистрации) выплаты в формате timestamp
      Необязательно description String [598] Описание выплаты
      Обязательно errorCode String Код ошибки обработки запроса (0 - нет ошибки)
      Условие errorMessage String [512] Описание ошибки
      Условие orderId String [36] Уникальный номер заказа в Модуле Выплат
      Обязательно orderNumber String [32] Уникальный идентификатор заказа в системе Партнера
      Обязательно

      OrderStatus Integer Значение этого параметра указывает статус заказа в платежном шлюзе. Отсутствует, если заказ не был найден. Ниже приведен список доступных значений:
      • 0 - заказ зарегистрирован, но не оплачен;
      • 1 - Предавторизованная сумма захолдирована (для двухстадийных платежей);
      • 2 - проведена полная авторизация суммы заказа;
      • 3 - авторизация отменена;
      • 4 - по транзакции была проведена операция возврата;
      • 5 - инициирована авторизация через ACS банка-эмитента;
      • 6 - авторизация отклонена.
      Условие orderParams Object Дополнительные параметры выплаты, переданные при выплате
      Необязательно orderParams.$name String Дополнительный параметр с любым названием
      Необязательно operationList Array of objects Объект, содержащий информацию о транзакциях, завершенных в заказе
      Необязательно operationList.amount Integer [12] Сумма операции в минимальных единицах валюты
      Необязательно operationList.cardholderName String [26] Имя держателя карты (при наличии)
      Необязательно operationList.currency Integer [3] Код валюты платежа ISO 4217
      Необязательно operationList.operationDate Integer Дата и время совершения операции в формате timestamp
      Необязательно operationList.operationType String Тип транзакции. Доступны следующие значения:
      • P2P_CREDIT - зачисляет деньги
      Необязательно operationList.orderId String Уникальный идентификатор заказа в Модуле Выплат
      Необязательно operationList.orderNumber String Уникальный номер заказа в система Партнера
      Необязательно operationList.panMaskedTo String [19] Маскированный номер карты для зачисления средств
      Необязательно operationList.refNum String [12] Идентификатор операции, который присваивается операции по ее завершению
      Необязательно operationList.resultCode Integer Код ошибки при выполнении запроса. Возможные значения:
      • 0 - в случае успеха;
      • 1 - в случае ошибки.
      Необязательно operationList.resultCodeDescription String [512] Описание кода ошибки транзакции
      Условие target Object Объект для передачи информации о реквизитах получателя средств
      Необязательно target.bindingId String [255] Идентификатор связки использованной для выплаты
      Необязательно target.clientId String [255] Идентификатор клиента использованный для выплаты
      Необязательно target.maskedPan String [19] Маскированный номер карты зачисления использованной для выплаты

      Пример запроса

      curl --location 'https://3dsec.berekebank.kz/payouts/api/v2/performPayout.do' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "username": "payout_api_username",
          "password": "payout_api_password",
          "orderNumber": "payout_1",
          "amount": 1234,
          "currency": "398",
          "client": {
              "clientId": "12345abc-d67e-8901-23fg-h45i67jk8901",
              "email": "payee@mail.com",
              "phone": "9991234567"
          },
          "target": {
              "pan": "4111111111111111"
          },
          "jsonParams": {
              "paramname1": "paramvalue1",
              "paramname2": "paramvalue2"
          }
      }'
      

      Пример ответа

      {
          "errorCode": "0",
          "errorMessage": "Успешно",
          "amount": 1234,
          "fee": 0,
          "currency": "398",
          "orderNumber": "1645458818059_12",
          "description": "Decent payout",
          "orderStatus": "2",
          "operationList": [
              {
                  "operationDate": 1665414462047,
                  "operationType": "P2P_CREDIT",
                  "amount": 1234,
                  "currency": "398",
                  "resultCode": 0,
                  "resultCodeDescription": "Перевод исполнен",
                  "refNum": "948498232196",
                  "pan": "411111XXXXXX1111",
                  "cardholderName": "CARDHOLDER NAME"
              }
          ],
          "source": {
              "bindingId": "83309cde-a56d-7409-88dd-c02e00ab3428"
          },
          "target": {
              "bindingId": "83309cde-a56d-7409-88dd-c02e00ab3428",
              "clientId": "12345abc-d67e-8901-23fg-h45i67jk8901",
              "maskedPan": "411111XXXXXX1111"
          },
          "orderParams": {
              "paramname1": "paramvalue1",
              "paramname2": "paramvalue2"
          }
      }
      

      Запрос статуса выплаты

      Для получения статуса выплаты необходимо использовать HTTPS POST API запрос /payouts/api/v2/getPayoutStatus.do

      Параметры запроса

      Обязательность Параметр Тип Описание
      Обязательно userName String [30] Логин Партнера, полученный при подключении
      Обязательно password String [30] Пароль Партнера, полученный при подключении
      Условие

      orderNumber String Идентификатор заказа на Выплату в системе Партнера. В запросе должен присутствовать либо orderId, либо orderNumber.
      Условие

      orderId String Уникальный идентификатор заказа в шлюзе.
      • отсутствует для выплат с типом CREDIT_ONLY и P2P_TRANSFER, т.к. совпадает с одноименным параметром в основном блоке;
      • присутствует для выплат с типом DEBIT_CREDIT и содержит идентификатор заказа в шлюзе, над которым выполнялась операция.
        Необязательно language String Язык в кодировке ISO 639-1. Если не указан, будет использован язык по умолчанию

        Параметры ответа

        Обязательность Параметр Тип Описание
        Обязательно errorCode String Код ошибки обработки запроса (0 - нет ошибки)
        Условие errorMessage String [512] Описание ошибки
        Обязательно amount Integer [12] Сумма выплаты в минимальных единицах валюты
        Необязательно fee Integer [12] Сумма комиссии в минимальных единицах валюты
        Обязательно

        currency String Код валюты платежа в соответствии с ISO 4217
        Обязательно orderNumber String [32] Уникальный идентификатор заказа в системе Партнера
        Условие orderId String [36] Уникальный номер заказа в Модуля Выплат
        Необязательно description String [598] Описание заказа
        Обязательно

        OrderStatus Integer Значение этого параметра указывает статус заказа в платежном шлюзе. Отсутствует, если заказ не был найден. Ниже приведен список доступных значений:
        • 0 - заказ зарегистрирован, но не оплачен;
        • 1 - Предавторизованная сумма захолдирована (для двухстадийных платежей);
        • 2 - проведена полная авторизация суммы заказа;
        • 3 - авторизация отменена;
        • 4 - по транзакции была проведена операция возврата;
        • 5 - инициирована авторизация через ACS банка-эмитента;
        • 6 - авторизация отклонена.
        Необязательно operationList Array of objects Объект, содержащий информацию о транзакциях, завершенных в заказе
        Необязательно operationList.amount Integer [12] Сумма операции в минимальных единицах валюты
        Необязательно operationList.cardholderName String [26] Имя держателя карты (при наличии)
        Необязательно operationList.currency Integer [3] Код валюты платежа ISO 4217
        Необязательно operationList.operationDate Integer Дата и время совершения операции в формате timestamp
        Необязательно operationList.operationType String Тип транзакции. Доступны следующие значения:
        • P2P_CREDIT - зачисляет деньги
        Необязательно operationList.orderId String Уникальный идентификатор заказа в Модуле Выплат
        Необязательно operationList.orderNumber String Уникальный номер заказа в система Партнера
        Необязательно operationList.panMaskedTo String [19] Маскированный номер карты для зачисления средств
        Необязательно operationList.refNum String [12] Идентификатор операции, который присваивается операции по ее завершению
        Необязательно operationList.resultCode Integer Код ошибки при выполнении запроса. Возможные значения:
        • 0 - в случае успеха;
        • 1 - в случае ошибки.
        Необязательно operationList.resultCodeDescription String [512] Описание кода ошибки транзакции
        Условие source Object Объект для передачи информации о реквизитах источника средств. Указывается только при использовании типа фондирования "Выплата денежных средств с корпоративной карты Партнера"
        Условие source.bindingId String Идентификатор связки, по реквизитам которой была проведена попытка списания денежных средств
        Условие target Object Объект для передачи информации о реквизитах получателя средств
        Необязательно target.bindingId String [255] Идентификатор связки, использованной для выплаты
        Необязательно target.clientId String [255] Идентификатор клиента, использованный для выплаты
        Необязательно target.maskedPan String [19] Маскированный номер карты зачисления, использованной для выплаты
        Условие orderParams Object Дополнительные параметры выплаты, переданные при выплате
        Необязательно orderParams.$name String Дополнительный параметр с любым названием

        Пример запроса

        curl --location 'https://3dsec.berekebank.kz/payouts/api/v2/getPayoutStatus.do' \
        --header 'Content-Type: application/json' \
        --data-raw '{
            "username": "payout_api_username",
            "password": "payout_api_password",
            "orderNumber": "payout_1"
        }'
        

        Пример ответа

        {
            "errorCode": "0",
            "errorMessage": "Успешно",
            "amount": 1234,
            "fee": 0,
            "currency": "398",
            "orderNumber": "1645458818059_12",
            "description": "Decent payout",
            "orderStatus": "2",
            "operationList": [
                {
                    "datetime": "1665414462047",
                    "operationType": "P2P_CREDIT",
                    "amount": 1234,
                    "currency": "643",
                    "resultCode": 0,
                    "resultCodeDescription": "Перевод исполнен",
                    "refNum": "948498232196",
                    "pan": "411111XXXXXX1111",
                    "cardholderName": "CARDHOLDER NAME"
                }
            ],
            "target": {
                "bindingId": "83309cde-a56d-7409-88dd-c02e00ab3428",
                "clientId": "12345abc-d67e-8901-23fg-h45i67jk8901",
                "maskedPan": "411111XXXXXX1111"
            },
            "orderParams": {
                "name1": "value1",
                "name2": "value2"
            }
        }
        

        Добавление корпоративной карты в личном кабинете

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

        Для Настроек выполните следующие шаги:


        Раздел меню Мои карты

        Для того, чтобы привязать банковскую карту, нажмите кнопку Добавить карту. После этого откроется окно Добавление карты, где необходимо заполнить все поля:


        Добавление карты для выплат в разделе меню Мои Карты

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

        В поле «Пароль» необходимо ввести пароль, высланный в СМС на ваш мобильный номер, к которому привязана карта. После ввода пароля нажмите на кнопку Подтвердить.

        Для подтверждения с добавляемой карты автоматически спишется (и сразу вернется) минимальная сумма. Добавленная карта отобразится на странице:


        Список карт в разделе меню Мои карты

        Если щелкнуть по привязанной карте, появляются кнопки:

        1. Сделать карту основной;
        2. Копировать ID связки;
        3. Удалить карту.


        Управление картами в разделе меню Мои карты

        Вам необходимо скопировать ID связки и использовать ее для указания в параметре source.bindingId HTTPS POST API запроса /payouts/api/v2/performPayout.do при проведении выплаты.

        Настройка КНП в Личном кабинете

        Чтобы настроить значение КНП, Вы должны обладать соответствующей пермиссией. Для настройки необходимо выполнить следующие действия.


        Подраздел меню Значение КНП


        Выбор значения КНП из справочника


        Сохранение выбранного значения КНП

        Описание ошибок

        HTTP code errorCode errorMessage Описание
        400 Bad request 98 [paramName] is а required parameter При запросе в модуль выплат не указан обязательный параметр
        400 Bad request 98 [paramName] does not match required pattern [pattern] При запросе в модуль выплат указанный параметр не соответствует заданному регулярному выражению
        400 Bad request 98 Errors while parsing incoming request: [requestMessage] is not set for method [api_method] При разборе входящего сообщения невозможно найти метод указанный в запросе
        400 Bad request 98 Invalid request При разборе входящего сообщения обнаружена ошибка
        400 Bad request 98 No order identification provided to find order in database Не указан Order ID. При формировании запроса в БД неудалось найти в запросе парметра по которому можно осуществить поиск
        400 Bad request 98 Order not found in payout proxy. Check orderId or orderNumber При запросе в модуль выплат указанный номер заказа не найден
        400 Bad request 98 Currency does not match required pattern При запросе в модуль выплат выбрана не корректна валюта
        400 Bad request 98 Сard affiliation does not match required pattern При запросе в модуль выплат выбрана карта не разрешенная в данном процессе
        400 Bad request 98 userName and password are mandatory fields При запросе в модуль выплат не указан логин или пароль
        400 Bad request 98 Payout config error: debit method is incorrect for specified payout type Для данного типа оплаты должен быть определен метод дебетования
        400 Bad request 98 Source is not specified or is incorrect compared to configured debit tools Источник в запросе отличается от ожидаемого
        401 Not authorized 90 User not authenticated Авторизация пользователя (продавца) в шлюзе завершилась неудачей
        404 Not Found - - Метод не найден
        500 Server error 99 No merchant settings available Не удалось найти настройки пользователя (продавца) по логину или авторизационному токену
        500 Server error 99 There was an error getting gateway parameters Ошибка разбора параметров подключений к шлюзам и\или микросервисам
        500 Server error 99 Failed to parse incoming request for [messageType] Ошибка при разборе входящего JSON сообщения указанного типа (например, некорректный JSON)
        502 Bad Gateway 99 Failed to call hessian method: [hessian_method] Ошибка вызова метода шлюза (метод не найден, параметры некорректны и т.п.)
        502 Bad Gateway 99 Error calling rest method [service_name] Ошибка вызова метода rest (метод не найден, параметры некорректны и т.п.)
        502 Bad Gateway 99 Rest response was unsuccessfull Ошибка вызова метода rest
        502 Bad Gateway 99 3DS authorization was requested but is not supported in API calls Ошибка вызова, запрошен 3ds, выплаты не поддерживают работу с 3ds
        502 Bad Gateway 99 Unable to get card data for specified bindingId По bindingId не получены данные карты из шлюза
        502 Bad Gateway 204 Cannot find any bin range in db for [bin] Введенный bin карты, не найден в Базе данных
        502 Bad Gateway 204 Unsupported pan Pan не поддерживается
        502 Bad Gateway 400 Invalid request: bin is empty or is not numeric Бин карты получателя пустой или не число
        502 Bad Gateway 98 Mrbin​␣can't​␣find​␣this​␣card Mr.bin не может найти данный номер карты в базе, необходимо проверить корректность ввода номера карты
        504 Timeout 91 Timeout when requesting [gateway] Шлюз недоступен
        504 Timeout 91 Timeout when requesting [service_name] Сервис недоступен
        Категории:
        Payouts API V1
        Категории
        Результаты поиска