Изменение статуса реестра платежей

Песочница

PATCH https://sandbox.alfabank.ru/api/jp/v1/registries/{registryId}

Пром

PATCH https://baas.alfabank.ru/api/jp/v1/registries/{registryId}

Scope

payment-registries

Описание

Метод позволяет перевести реестр рублёвых платёжных поручений в статус «На подпись» или «На обработке».

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H

stringrequired

application/json

Content-Type

stringrequired

application/json

PATH

Атрибут

Описание

registryId

stringrequired

Идентификатор реестра, полученный в ответе метода «Создание реестра рублёвых платежей»

BODY

Атрибут

Описание

status

stringrequired

Статус реестра платежей. Возможные значения:

•

ON_SIGNING - на подпись;
•

PROCESSING - на обработке

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

Язык

1curl --location --globoff --request PATCH 'https://baas.alfabank.ru/api/jp/v1/registries/{registryId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "status": "ON_SIGNING"
7}'

Параметры ответа

Пример ответа 200 (OK)

1{
2  "status": "ON_SIGNING",
3  "description": "Описание реестра",
4  "payerAccount": "40702810102300000001",
5  "urgencyCode": "NORMAL",
6  "content": "YW1vdW50PTEwMC4wMApkYXRlPTIwMTgtMDUtMzEKZGVwYXJ0bWVudGFsSW5mby...NOdW1iZXIx="
7}

BODY

атрибут

описание

status

stringrequired

Статус реестра платежей. Принимает возможные значения:

•

ON_SIGNING - на подпись;
•

PROCESSING - на обработке

description

stringoptional

Описание реестра

payerAccount

stringrequired

Счёт списания

urgencyCode

stringrequired

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

•

OFFHOURS - продлённый операционный день;
•

BESP - срочный платёж;
•

NORMAL - стандартный операционный день

content

stringoptional

Содержимое документа в формате base64

Пример ответа 200 (OK)

1{
2  "status": "ON_SIGNING",
3  "description": "Описание реестра",
4  "payerAccount": "40702810102300000001",
5  "urgencyCode": "NORMAL",
6  "content": "YW1vdW50PTEwMC4wMApkYXRlPTIwMTgtMDUtMzEKZGVwYXJ0bWVudGFsSW5mby...NOdW1iZXIx="
7}

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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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 и параметра prompt=consent

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}

Нет тела ответа