Kaspi Bank

При работе с запросами на проверку существования в вашей системе лицевого счета пользователя необходимо учитывать следующее:

1. Запрос verify для проверки существования лицевого счета пользователя платежная платформа отправляет на URL-адрес вашей системы методом POST.
2. Запрос содержит следующие обязательные параметры:
   • type — тип операции в вашей системе, значение параметра всегда verify;
   • customer_id — идентификатор учетной записи пользователя в вашей системе, на баланс которой зачисляются денежные средства;
   • project_id — идентификатор проекта, полученный от JetPay при интеграции;
   • signature — подпись запроса.

   Рис.: Пример данных из запроса на проверку существования лицевого счета пользователя

   {
       "type": "verify",
       "project_id": 1234,
       "customer_id": "7123456789",
       "signature": "e19695449545fac562843ca06e7e0f3e51281ad6"
   }

3. Ответ на запрос verify должен отправляться синхронно и содержать следующие обязательные параметры:
   • code — код ответа на запрос;
   • additional_customer_id — идентификатор пользователя, уникальный в рамках проекта, который используется для идентификации пользователя в платежной платформе JetPay. Данный параметр обязателен для ответа с кодом 0;
   • currency — код валюты платежа в формате ISO-4217 alpha-3. Данный параметр обязателен для ответа с кодом 0;
   • entities.id — идентификатор договора. Данный параметр обязателен для ответа с кодом 0;
   • entities.number — номер договора. Данный параметр обязателен для ответа с кодом 0;
   • entities.payment — сумма оплаты в дробных единицах валюты без десятичной точки и пробелов за исключением случаев, когда у валюты нет дробной части. Если у валюты нет дробных единиц (то есть количество разрядов дробных единиц равно нулю), то в этом параметре нужно указывать сумму в основных единицах валюты. Подробнее о разрядах дробных единиц у валют см. Коды валют. Обязательность этого параметра уточняйте у курирующего менеджера JetPay.

   Табл. 1. Допустимые коды ответов

   Код	Описание
   0	Операция успешна
   400	Ошибка подписи
   404	Счет пользователя не существует
   500	Общая ошибка, причина должна быть описана в параметре message

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

   • message — произвольное описание кода ответа;
   • entities.info — объект с произвольным набором полей, используется для отображения дополнительной информации пользователю. Структура согласовывается индивидуально, уточняйте у курирующего менеджера JetPay;
   • entities.min_payment — минимальная сумма оплаты в дробных единицах валюты без десятичной точки и пробелов за исключением случаев, когда у валюты нет дробной части. Если у валюты нет дробных единиц (то есть количество разрядов дробных единиц равно нулю), то в этом параметре нужно указывать сумму в основных единицах валюты. Подробнее о разрядах дробных единиц у валют см. Коды валют.

   Вот пример ответа на запрос, если лицевой счет пользователя существует в вашей системе.

   Рис.: Пример ответа на запрос

   {
       "code": 0,
       "currency": "KZT",
       "entities": [
           {
               "id": "12345",
               "number": "1234_ABC/01-01-2025/Abcdef12",
               "min_payment": 100000,
               "payment": 100000,
               "info": {
                   "total_debt": 500000,
                   "monthly_payment": 100000,
                   "customer_name": "John Doe"
               }
           },
           {
               "id": "67890",
               "number": "5678_ABC/01-01-2025/Abcdef34",
               "min_payment": 100000,
               "payment": 150000,
               "info": {
                   "total_debt": 1000000,
                   "monthly_payment": 150000,
                   "customer_name": "John Doe"
               }
           }
       ],
       "additional_customer_id": "ABCDE12345"
   }

   Если запрос нельзя корректно обработать или не удалось обнаружить запрошенный лицевой счет, ответ на запрос должен содержать код ответа 404, а также может содержать дополнительную информацию об ошибке в параметре message.

   Рис.: Пример ответа с кодом ошибки

   { 
       "code": 404,
       "message": "Account does not exist"
   }

При работе с запросами на получение идентификатора платежа в вашей системе необходимо учитывать следующее:

1. Запрос check_deposit для получения идентификатора платежа платежная платформа отправляет методом POST на URL-адрес вашей системы.
2. Запрос содержит следующие обязательные параметры:
   • type — тип операции в вашей системе, значение параметра всегда check_deposit;
   • project_id — идентификатор проекта, полученный от JetPay при интеграции;
   • customer_id — идентификатор учетной записи пользователя в вашей системе, на баланс которой зачисляются денежные средства;
   • entity_id — идентификатор договора, по которому выполняется оплата;
   • amount — сумма оплаты в дробных единицах валюты без десятичной точки и пробелов за исключением случаев, когда у валюты нет дробной части. Если у валюты нет дробных единиц (то есть количество разрядов дробных единиц равно нулю), то в этом параметре нужно указывать сумму в основных единицах валюты. Подробнее о разрядах дробных единиц у валют см. Коды валют;
   • currency — валюта платежа в формате ISO-4217 alpha-3;
   • payment_method — идентификатор платежного метода, значение параметра всегда terminal/kaspi;
   • signature — подпись запроса.

   Рис.: Пример данных из запроса на получение идентификатора платежа в вашей системе

   { 
      "type": "check_deposit",
      "project_id": 1234,
      "customer_id": "123456789",
      "entity_id": "12345",
      "amount": 10000,
      "currency": "KZT",
      "payment_method": "terminal/kaspi",
      "signature": "lY0LTSAzpR7zGce5qfYGacOuYlHANnkIR7mdOqRXJnL1kO0lUmkQ0YYLWRg=="
   }

3. Ответ на запрос check_deposit должен отправляться синхронно и содержать следующие обязательные параметры:
   • code — код ответа на запрос;
   • payment_id — уникальный идентификатор платежа в вашей системе. Данный параметр обязателен для ответа с кодом 0.

   Табл. 2. Допустимые коды ответов

   Код	Описание
   0	Операция успешна
   400	Ошибка подписи
   404	Cчет пользователя не существует
   500	Общая ошибка, причина должна быть описана в параметре message

   Ответ может также содержать следующие необязательные параметры:

   • message — произвольное описание кода ответа;
   • description — описание платежа.

   Ответ на запрос получения идентификатора платежа в вашей системе должен содержать код ответа на запрос и уникальный идентификатор платежа.

   Рис.: Пример ответа с идентификатором платежа

   {
       "code": 0,
       "payment_id": "payment_47",
       "description": "Success"
   }

   Ответ c информацией об ошибке должен содержать код ответа на запрос и сообщение об ошибке.

   Рис.: Пример ответа с информацией об ошибке

   {
       "code": 500,
       "message": "Something went wrong"
   }