Получение списка доступных банков для вывода через СБП

Запрос

URL

https://api.mivion.com/payoff/get-sbp-bank-list

Метод отправки

GET

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

nametypedescription
user_id*uuidИдентификатор пользователя (используется для авторизации, подставляется в ссылку)
type
uuid
description
Идентификатор пользователя (используется для авторизации, подставляется в ссылку)

* Поля обязательные для заполнения

Ответ после запроса:

Формат ответа

JSON

nametypedescription
banksarrayМассив с данными банков, подключенных к системе быстрых платежей (СБП)
banks.*objectЭлемент массива
banks.*.idstringID банка в системе быстрых платежей (СБП)
banks.*.namestringНаименование банка
type
array
description
Массив с данными банков, подключенных к системе быстрых платежей (СБП)
type
object
description
Элемент массива
type
string
description
ID банка в системе быстрых платежей (СБП)
type
string
description
Наименование банка

Возможные статусы ответа:

  • 200 : Успех
  • 401 : Ошибка авторизации (неверный user_id или секретный ключ)
  • 422 : Ошибка валидации
  • 500 : Внутренняя ошибка системы

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

URL

https://api.mivion.com/payoff/get-sbp-bank-list?user_id=a6f112da-7c3f-4323-ad99-ec3630e7c8ff

Метод отправки

GET

  1. 1.curl -X 'GET' \
  2. 2.'https://api.mivion.com/payoff/get-sbp-bank-list?user_id=a6f112da-7c3f-4323-ad99-ec3630e7c8ff' \
  3. 3.-H 'accept: application/json' \
  4. 4.-H 'x-api-signature-sha256: d6be996241deef230e9a0ca9dc60679da8720d14'

Responses

При успешном запросе: код ответа - 200.

  1. 1.{
  2. 2. "data": {
  3. 3. "banks": [
  4. 4. {
  5. 5. "id": "100000000001",
  6. 6. "name": "Газпромбанк",
  7. 7. },
  8. 8. {
  9. 9. "id": "100000000003",
  10. 10. "name": "Банк Синара",
  11. 11. },
  12. 12. {
  13. 13. "id": "100000000004",
  14. 14. "name": "Тинькофф Банк",
  15. 15. }
  16. 16. ]
  17. 17. }
  18. 18.}

При ошибке: код ответа - 401, 422, 500.

  1. 1.{
  2. 2. "data": null,
  3. 3. "error": "Поле user id обязательно для заполнения.",
  4. 4. "status": 422,
  5. 5. "status": false,
  6. 6.}

Примеры кода:

  1. 1.import requests
  2. 2.
  3. 3.
  4. 4.# Payoff info
  5. 5.def get_sbp_bank_list(api_key, user_id):
  6. 6. session = requests.Session()
  7. 7. session.headers['Accept'] = 'application/json'
  8. 8. session.headers['x-api-signature-sha256'] = api_key
  9. 9. params = {
  10. 10. "user_id": user_id,
  11. 11. }
  12. 12. response = session.get('https://api.mivion.com/payoff/get-sbp-bank- list', params=params)
  13. 13. return response.json()
  14. 14.
  15. 15.
  16. 16.api_key = 'd6be996241deef230e9a0ca9dc60679da8720d14'
  17. 17.user_id = 'a6f112da-7c3f-4323-ad99-ec3630e7c8ff'
  18. 18.
  19. 19.# Response
  20. 20.sbpBanks = get_sbp_bank_list(api_key, user_id)
  21. 21.
  22. 22.# Response status
  23. 23.sbpBanks['status']
  24. 24.
  25. 25.# Sbp banks list
  26. 26.sbpBanks['data']['banks']
  27. 27.
  28. 28.# sbp bank data
  29. 29.# ID банка
  30. 30.sbpBanks['data']['banks'][0]['id'];
  31. 31.# Наименование банка
  32. 32.sbpBanks['data']['banks'][1]['name'];
  1. 1.function getSbpBanks(string $apiKey, string $userId): array
  2. 2.{
  3. 3. $url = "https://api.mivion.com/payoff/get-sbp-bank-list";
  4. 4. $headers = [
  5. 5. "accept: application/json",
  6. 6. "x-api-signature-sha256: {$apiKey}"
  7. 7. ];
  8. 8.
  9. 9. $ch = curl_init();
  10. 10. curl_setopt($ch, CURLOPT_URL, "$url?user_id={$userId}");
  11. 11. curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  12. 12. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  13. 13. $response = curl_exec($ch);
  14. 14. curl_close($ch);
  15. 15. return json_decode($response, true);
  16. 16.}
  17. 17.
  18. 18.$apiKey = "d6be996241deef230e9a0ca9dc60679da8720d14";
  19. 19.$userId = "a6f112da-7c3f-4323-ad99-ec3630e7c8ff";
  20. 20.
  21. 21.# Response
  22. 22.$sbpBanks = getSbpBanks($apiKey, $userId);
  23. 23.
  24. 24.# Response status
  25. 25.$sbpBanks['status'];
  26. 26.
  27. 27.# sbp banks list
  28. 28.$sbpBanks['data']['banks'];
  29. 29.
  30. 30.# sbp bank data
  31. 31.# ID банка
  32. 32.$sbpBanks['data']['banks'][0]['id'];
  33. 33.# Наименование банка
  34. 34.$sbpBanks['data']['banks'][1]['name'];