B2BH2H

Получение печатной формы платёжного поручения в Base64

Пром GET https://baas.alfabank.ru/api/payments/{externalId}/print-form

Песочница GET https://sandbox.alfabank.ru/api/payments/{externalId}/print-form

Scope

payment

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

HEADERS
Атрибут
Описание
Authorization
stringrequired

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

Accept
stringrequired

application/json

PATH
Атрибут
Описание
externalId
stringrequired

Идентификатор документа, присвоенный партнером (UUID)

Пример запроса
curl -X GET https://baas.alfabank.ru/api/payments/{externalId}/print-form \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Пример ответа 200 (ОК)
{
    "fileName": "Платежное_поручение_№2_17.11.2022.pdf",
    "content": "JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDIwMDA...PgpzdGFydHhyZWYKMTE4MDkKJSVFT0YK"
}
fileName
stringoptional

Имя файла

content
stringoptional

Содержимое файла в Base64

Пример ответа 200 (ОК)
{
    "fileName": "Платежное_поручение_№2_17.11.2022.pdf",
    "content": "JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDIwMDA...PgpzdGFydHhyZWYKMTE4MDkKJSVFT0YK"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Parameter externalId is not valid"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен, not_found - Платёж не найден или пока не исполнен.

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "not_found",
  "error_description": "The payment document has not yet been executed"
}
error
stringrequired

Код ошибки. Принимает возможные значения: conflict - Платёжное поручение с таким externalId недоступно

error_description
stringoptional

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

Пример ошибки 409 (Conflict)
{
  "error": "conflict",
  "error_description": "Payment with this externalId is not available. Please create a new externalId for document"
}
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

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

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.