Scope
payment
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
application/json
Идентификатор документа, присвоенный партнёром (UUID)
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v2/payments/{externalId}/state' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
1{
2 "bankStatus": "ACCEPTED",
3 "bankComment": "Отправим платёж в течение банковского дня",
4 "crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316"
5}Статус документа. Принимает возможные значения:
-
•
ACCEPTED- принят; -
•
CREATED- создан; -
•
PARTSIGNED- отправлен на подпись или частично подписан; -
•
SIGNED- подписан; -
•
CARD2- ожидает оплаты; -
•
DELETED- удален; -
•
REFUSEDBYBANK- отвергнут банком; -
•
REQUISITEERROR- ошибка реквизитов; -
•
IMPLEMENTED- исполнен
Примечание: статус IMPLEMENTED не всегда окончательный - после перехода в этот статус платёж может автоматически перейти в REFUSEDBYBANK, например, если банк-получатель отклонит зачисление из-за неверных реквизитов получателя. Рекомендуется продолжать опрашивать API в течение 15 минут после получения статуса IMPLEMENTED
Банковский комментарий к статусу документа
Hash от ключевых полей документа
1{
2 "bankStatus": "ACCEPTED",
3 "bankComment": "Отправим платёж в течение банковского дня",
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- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощьюrefresh_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- эндпоинт не найден или неактивен; -
•
not_found- платёж не найден или пока не исполнен
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}