Scope
payment
Описание
Метод позволяет отправить платёжное поручение на подпись. После выполнения запроса платёж можно посмотреть на вкладке «На подпись» раздела «Платежи в работе» интерфейса Альфа-Бизнес.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
application/json
application/json
Идентификатор документа, присвоенный партнёром (UUID)
Статус документа. Возможные значения:
-
•
PARTSIGNED- отправлен на подпись или частично подписан
1curl --location --globoff --request PATCH 'https://baas.alfabank.ru/api/jp/v2/payments/{externalId}/state' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "bankStatus": "PARTSIGNED"
7}'Параметры ответа
1{
2 "bankStatus": "PARTSIGNED",
3 "bankComment": null,
4 "crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316"
5}Статус документа. Принимает возможные значения:
-
•
PARTSIGNED- отправлен на подпись или частично подписан
Банковский комментарий к статусу документа
Hash от ключевых полей документа
1{
2 "bankStatus": "PARTSIGNED",
3 "bankComment": null,
4 "crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316"
5}Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметраprompt=consent
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен; -
•
payment_not_found- платёж не найден
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
status_check_error- платёжное поручение находится в неподходящем для операции статусе
Описание ошибки
1{
2 "error": "status_check_error",
3 "error_description": "The payment is in an unsuitable status for the operation"
4}Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}