Skip to content

SBP bank list

Returns the general directory of SBP banks. Use the bank_id and bank_bic values when checking payout feasibility and creating a payout via SBP.

URL

GET https://api.pay.kvell.group/v1/collections/banks

GET https://api.pay.stage.kvell.group/v1/collections/banks

Request

Headers

Name Type Required Description
X-Api-Key string Yes Shop identifier.

The X-Signature signature is not required for this method.

Example

curl --request GET \
  --url 'https://api.pay.stage.kvell.group/v1/collections/banks' \
  --header 'X-Api-Key: 00000000-0000-4000-8000-000000000000'

Response

Select an HTTP code to see the example, response parameters, and recommended actions.

Example 200 (OK) response
[
  {
    "bank_id": "100000000014",
    "bank_bic": "044525151",
    "name": "Банк Русский Стандарт"
  },
  {
    "bank_id": "100000000202",
    "bank_bic": "044525845",
    "name": "Норвик Банк"
  },
  {
    "bank_id": "100000000051",
    "bank_bic": null,
    "name": "Далена Банк"
  }
]

Response parameters

Parameter Type Description
bank_id string Bank identifier in SBP.
bank_bic string | null Bank BIC. Returns null if the BIC is missing from the directory.
name string Bank name.
Example 403 (Forbidden) response
{
  "errors": [
    {
      "code": 20037,
      "message": "Доступ запрещен"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and handling recommendations are given in the «HTTP response errors» section.
errors[].code integer Error code.
errors[].message string Description of the access denial reason.
Example 404 (Not Found) response
{
  "errors": [
    {
      "code": 20006,
      "message": "Магазин не найден"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and handling recommendations are given in the «HTTP response errors» section.
errors[].code integer Error code.
errors[].message string Description of the resource that was not found.
Example 422 (Unprocessable Entity) response
{
  "errors": [
    {
      "code": 20098,
      "message": "x-api-key: Field required"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of validation errors. Codes and handling recommendations are given in the «HTTP response errors» section.
errors[].code integer Error code.
errors[].message string Field and reason for the validation error.
Example 5XX (Internal Server Error) response
{
  "errors": [
    {
      "code": 20000,
      "message": "Неизвестная ошибка"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and handling recommendations are given in the «HTTP response errors» section.
errors[].code integer Technical error code.
errors[].message string Description of the technical error.

What to do next

  1. Safely retry the same GET request with the same X-Api-Key.
  2. If the error recurs, contact KVELL support and provide the URL, request time, HTTP code, code, and message.