H2H

Получение статуса запроса на выплату с номинального счёта

Песочница
GET https://sandbox.alfabank.ru/api/na/jp/v1/payoffs/{payoffId}/status
Пром
GET https://baas.alfabank.ru/api/na/jp/v1/payoffs/{payoffId}/status
Scope

beneficiary-payments

Описание

Метод позволяет получить статус запроса на выплату с номинального счёта по payoffId.

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

application/json

PATH
Атрибут
Описание
payoffId
stringrequired
Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/payoffs/{payoffId}/status' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "payoffId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "status": "PENDING"
4}
BODY
атрибут
описание
payoffId
stringrequired

Идентификатор запроса

status
stringrequired

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

  • •
    PENDING - запрос в процессе обработки;
  • •
    MANUAL_ACCEPTANCE - ожидание ручного подтверждения отправки запроса-дубля на обработку;
  • •
    AWAIT_EXTERNAL - ожидание исполнения внешнего платежа;
  • •
    FAILED - обработка запроса завершилась ошибкой;
  • •
    FAILED_DUPLICATE - обработка запроса-дубля отклонена;
  • •
    COMPLETE - обработка запроса завершилась успешно
description
stringoptional

Описание причины, по которой запрос завершился неуспешно. Возвращается, если статус запроса равен FAILED

Пример ответа 200 (OK) 
1{
2  "payoffId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "status": "PENDING"
4}
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 и параметра 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}
Нет тела ответа
Создание запроса на выплату с номинального счётаПодтверждение или отклонение запроса-дубля на выплату