Skip to content

List of banks by phone number

A method for retrieving the list of SBP banks that have previously received transfers to the specified phone number. The list is built from transfer history (historical data) on the bank's side.

The list is for reference only

This is transfer history, not a list of the recipient's accounts in SBP. If the recipient's bank is absent from the response, this does not mean the payout to it is impossible — check actual feasibility with the payout feasibility check method.

URL

GET https://api.pay.kvell.group/v1/orders/payout/sbp/banks/{phone}

GET https://api.pay.stage.kvell.group/v1/orders/payout/sbp/banks/{phone}

Request

Path parameters

Parameter Type Required Description
phone string Yes Recipient's phone number: 11 digits, country code 7, without +, spaces, or separators. Example: 79991234567.

Headers

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

Building the signature

Concatenate X-Api-Key, phone, and secret_key without separators, compute the SHA-256 of the resulting UTF-8 string, and pass the lowercase hex result in the X-Signature header.

SHA256(X-Api-Key + phone + secret_key)

secret_key can be found in the shop's settings.

Example

curl --request GET \
  --url 'https://api.pay.stage.kvell.group/v1/orders/payout/sbp/banks/79991234567' \
  --header 'X-Api-Key: 00000000-0000-4000-8000-000000000000' \
  --header 'X-Signature: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef'

Response

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

Example 200 (OK) response
[
  {
    "bank_id": "100100000014",
    "bank_bic": "012345678",
    "name": "RSB+ (Russian Standard Bank)"
  },
  {
    "bank_id": "100000000202",
    "bank_bic": "012345678",
    "name": "Norvik Bank"
  },
  {
    "bank_id": "100000000201",
    "bank_bic": null,
    "name": "Kremlin Bank"
  }
]

If there is no historical data for the phone number, the method returns an empty array:

Example of an empty list
[]

Response parameters

Parameter Type Description
bank_id string Bank identifier in SBP.
bank_bic string | null Bank's BIC. Returned as null if the BIC is absent from the directory.
name string Bank name.
Example 400 (Bad Request) response
{
  "errors": [
    {
      "code": 20002,
      "message": "Invalid signature"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and recommendations are given in the «HTTP response errors» section.
errors[].code integer Error code. In the example — 20002.
errors[].message string Description of why the request was rejected.

What to do next

  1. Check the phone number in the URL, the order of values in the signature, and the shop's secret key.
  2. Build the correct X-Signature and retry the request.
Example 403 (Forbidden) response
{
  "errors": [
    {
      "code": 20037,
      "message": "Access denied"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and recommendations are given in the «HTTP response errors» section.
errors[].code integer Error code. In the example — 20037.
errors[].message string Description of why access was denied.
Example 404 (Not Found) response
{
  "errors": [
    {
      "code": 20006,
      "message": "Shop not found"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and recommendations are given in the «HTTP response errors» section.
errors[].code integer Error code. In the example — 20006.
errors[].message string Description of the resource that was not found.

What this response means

No shop was found for the given X-Api-Key. The response does not mean there are no banks for the phone number.

What to do next

  1. Check the X-Api-Key and the request environment.
  2. Retry the request only after fixing the key or the environment URL.
Example 422 (Unprocessable Entity) response
{
  "errors": [
    {
      "code": 20098,
      "message": "phone: Invalid phone number format"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of validation errors. Codes and recommendations are given in the «HTTP response errors» section.
errors[].code integer Error code. For a field error — 20098.
errors[].message string Field and reason for the validation error.
Example 5XX (Internal Server Error) response
{
  "errors": [
    {
      "code": 20000,
      "message": "Unknown error"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and 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 phone, X-Api-Key, and X-Signature.
  2. If the error persists, contact KVELL support and provide the URL, request time, HTTP code, code, and message.