B2BH2H

Обновление статусов платёжных ссылок

Песочница
PATCH https://sandbox.alfabank.ru/api/sbp/jp/v1/payment-urls
Пром
PATCH https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls
Scope

b2b-sbp

Описание

Метод позволяет изменять текущие статусы платёжных ссылок на статусы, указанные в запросе.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
objectrequired

Контекст клиента

b2bClientId
stringrequired

Идентификатор клиента, от имени которого выполняется запрос, в формате UUID. Банк сообщает партнёру API при подключении

partnerId
integerrequired

Идентификатор партнёра. Банк сообщает партнёру API при подключении

array of objectsrequired

Данные платёжной ссылки

qrcId
stringrequired

Идентификатор платёжной ссылки

isActive
booleanrequired

Новый статус платёжной ссылки. Возможные значения:

  • •
    true - действующая;
  • •
    false - недействующая, оплата невозможна
Пример запроса
Язык
1curl --location --request PATCH 'https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--data '{
5  "client": {
6    "b2bClientId": "021be5ed-6312-4982-a4e9-2a2cc44bc88c",
7    "partnerId": 214
8  },
9  "paymentUrls": [
10    {
11      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
12      "isActive": true
13    }
14  ]
15}'
Параметры ответа
1Нет тела ответа
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа