Перейти до основного вмісту
У цьому документі буде представлено опис інтеграції API для верифікації трьох елементів банківської картки, який може бути використаний для перевірки достовірності та узгодженості інформації про номер банківської картки, ім’я та номер документа, що підтверджує відкриття рахунку.

​
Процес подачі заявки

Щоб використовувати API, спочатку потрібно перейти на відповідну сторінку API верифікації трьох елементів банківської картки для подачі заявки на відповідну послугу. Після переходу на сторінку натисніть кнопку «Acquire», як показано на малюнку: Якщо ви ще не увійшли в систему або не зареєстровані, вас автоматично перенаправлять на сторінку входу, щоб запросити реєстрацію та вхід. Після входу або реєстрації ви автоматично повернетеся на поточну сторінку. При першій подачі заявки вам буде надано безкоштовний ліміт, який дозволяє безкоштовно використовувати цей API.

​
Основне використання

Спочатку потрібно ознайомитися з основним способом використання, а саме, введенням інформації про номер банківської картки, щоб отримати оброблене зображення результату. Спочатку потрібно просто передати поле bank_card. Далі ми можемо заповнити відповідні дані на інтерфейсі, як показано на малюнку:

Ми можемо бачити, що тут ми налаштували заголовки запиту, включаючи:
  • accept: формат відповіді, який ви хочете отримати, тут вказано application/json, тобто формат JSON.
  • authorization: ключ для виклику API, після подачі заявки ви можете вибрати його зі списку.
Також налаштовано тіло запиту, яке включає:
  • bank_card: інформація про номер банківської картки, є обов’язковим параметром.
  • id_card: номер документа, що підтверджує відкриття рахунку, є обов’язковим параметром.
  • name: ім’я користувача, є обов’язковим параметром.
  • cert_type: тип документа, що підтверджує відкриття рахунку, повинен відповідати документу, інакше верифікація не буде можлива.
  • encryption: необов’язковий параметр для шифрування чутливих полів (якщо потрібно передати зашифровані дані).
Після вибору ви можете помітити, що праворуч також згенеровано відповідний код, як показано на малюнку:

Натисніть кнопку «Try», щоб провести тестування, як показано на малюнку, тут ми отримали наступний результат: 
{
  "result": "0",
  "description": "Аутентифікація пройшла"
}
Повернуті результати містять кілька полів, описаних нижче:
  • result, код результату аутентифікації, умови оплати такі:
    • Код результату оплати:
      • 0: Аутентифікація пройшла
      • -1: Аутентифікація не пройшла
      • -4: Інформація про власника картки неправильна
      • -5: Не активовано безкарткову оплату
      • -6: Цю картку конфісковано
      • -7: Неправильний номер картки
      • -8: Ця картка не має відповідного емітента
      • -9: Ця картка не ініціалізована або спляча картка
      • -10: Картка шахрайства, картка, що застрягла
      • -11: Цю картку було втрачено
      • -12: Ця картка прострочена
      • -13: Обмежена картка
      • -14: Перевищено кількість спроб введення пароля
      • -15: Емітент картки не підтримує цю транзакцію
    • Код результату без оплати:
      • -2: Перевірка імені не пройшла
      • -3: Номер банківської картки неправильний
      • -16: Сервіс верифікаційного центру перевантажений
      • -17: Перевищено кількість спроб верифікації, будь ласка, спробуйте наступного дня
  • description, опис бізнес-результату.
Можна побачити, що достовірність та узгодженість інформації про номер банківської картки, ім’я та номер документа, що підтверджує відкриття рахунку, пройшли перевірку. Крім того, якщо ви хочете згенерувати відповідний код інтеграції, ви можете просто скопіювати його, наприклад, код CURL виглядає так: 
curl -X POST 'https://api.acedata.cloud/identity/bankcard/check-3e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "bank_card": "***",
  "id_card": "***"
}'
Код інтеграції на Python виглядає так: 
import requests

url = "https://api.acedata.cloud/identity/bankcard/check-3e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "bank_card": "***",
    "id_card": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Обробка помилок

При виклику API, якщо виникає помилка, API поверне відповідний код помилки та інформацію. Наприклад:
  • 400 token_mismatched: Неправильний запит, можливо, через відсутні або недійсні параметри.
  • 400 api_not_implemented: Неправильний запит, можливо, через відсутні або недійсні параметри.
  • 401 invalid_token: Неавторизовано, недійсний або відсутній токен авторизації.
  • 429 too_many_requests: Занадто багато запитів, ви перевищили ліміт запитів.
  • 500 api_error: Внутрішня помилка сервера, щось пішло не так на сервері.

​
Приклад відповіді з помилкою

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "не вдалося отримати"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Висновок

Завдяки цьому документу ви дізналися, як використовувати API верифікації трьох елементів банківської картки для перевірки достовірності та узгодженості інформації про номер банківської картки, ім’я та номер документа, що підтверджує відкриття рахунку. Сподіваємося, що цей документ допоможе вам краще інтегрувати та використовувати цей API. Якщо у вас є будь-які питання, будь ласка, звертайтеся до нашої технічної підтримки.