B2BH2H

Получение атрибутов платёжного поручения

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

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

Scope

payment

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

HEADER
Атрибут
Описание
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} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Пример ответа 200 (ОК)
{
  "amount": 1.01,
  "bankComment": null,
  "bankStatus": "CREATED",
  "crucialFieldsHash": "e28b4eaf7cfbec683a665b1513681e02e49cff891b476c2b3e046c0d961e32b2",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "departmentalInfo": {
    "uip": "0",
    "drawerStatus101": "01",
    "kbk": "18210102010011000110",
    "oktmo": "45902000",
    "reasonCode106": "ТП",
    "taxPeriod107": "ГД.00.2021",
    "docNumber108": "000000000000001",
    "docDate109": "2021-12-14",
    "paymentKind110": "0"
  },
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "2",
  "number": "1",
  "operationCode": "01",
  "payeeAccount": "40702810564564564531",
  "payeeBankBic": "040173745",
  "payeeBankCorrAccount": "30101810800000000745",
  "payeeInn": "7723870785",
  "payeeKpp": "553453453",
  "payeeName": "Общество с ограниченной ответственностью \"Получатель\"",
  "payerAccount": "40702810600010800068",
  "payerBankBic": "044525593",
  "payerBankCorrAccount": "30101810200000000593",
  "payerInn": "7728168971",
  "payerKpp": "770801001",
  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
  "priority": "5",
  "purpose": "7736576798//772201001//Наименование третьего лица//Единый налоговый платеж. НДС не облагается",
  "urgencyCode": "NORMAL",
  "vat": {
    "rate": "0",
    "type": "NO_VAT"
  }
}
amount
numberrequired

Сумма платежа

bankComment
stringoptional

Банковский комментарий к статусу документа

bankStatus
stringoptional

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

  • •
    ACCEPTED - Принят;
  • •
    CREATED - Создан;
  • •
    SIGNED - Подписан;
  • •
    CARD2 - Ожидает оплаты;
  • •
    DELETED - Удалён;
  • •
    REFUSEDBYBANK - Отвергнут банком;
  • •
    REQUISITEERROR - Ошибка реквизитов;
  • •
    IMPLEMENTED - Исполнен
crucialFieldsHash
stringoptional

Hash от ключевых полей документа

date
stringrequired

Дата составления документа в формате YYYY-MM-DD

deliveryKind
stringoptional

Вид платежа

objectoptional

Реквизиты налогового, таможенного или иного бюджетного платежа

uip
stringoptional

Уникальный идентификатор платежа

drawerStatus101
stringoptional

Показатель статуса налогоплательщика

kbk
stringoptional

Код бюджетной классификации

oktmo
stringoptional

Код OKTMO

reasonCode106
stringoptional

Показатель основания платежа

taxPeriod107
stringoptional

Налоговый период или код таможенного органа

docNumber108
stringoptional

Номер налогового документа

docDate109
stringoptional

Дата налогового документа в формате YYYY-MM-DD

paymentKind110
stringoptional

Тип налогового платежа

externalId
stringrequired

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

incomeTypeCode
stringoptional

Код вида дохода получателей выплаты по 229-ФЗ

number
stringoptional

Номер документа

operationCode
stringrequired

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

  • •
    01 - Платёжное поручение
payeeAccount
stringrequired

Счёт получателя платежа

payeeBankBic
stringrequired

БИК банка получателя платежа

payeeBankCorrAccount
stringoptional

Корсчет банка получателя платежа

payeeInn
stringoptional

ИНН получателя платежа

payeeKpp
stringoptional

КПП получателя платежа

payeeName
stringrequired

Полное наименование получателя платежа

payerAccount
stringrequired

Счёт плательщика

payerBankBic
stringrequired

БИК банка плательщика

payerBankCorrAccount
stringrequired

Корсчет банка плательщика

payerInn
stringrequired

ИНН плательщика

payerKpp
stringoptional

КПП плательщика

payerName
stringrequired

Полное наименование плательщика

priority
stringrequired

Очерёдность платежа

purpose
stringrequired

Назначение платежа

urgencyCode
stringoptional

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

  • •
    OFFHOURS - Продлённый операционный день;
  • •
    BESP - Срочный платёж;
  • •
    NORMAL - Стандартный операционный день
objectoptional

Данные НДС

amount
numberoptional

Сумма НДС

rate
stringoptional

Ставка НДС. Принимает возможные значения: 0 , 10 , 20

type
stringrequired

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

  • •
    INCLUDED - НДС включён в сумму платежа;
  • •
    ONTOP - НДС добавляется к сумме платежа;
  • •
    NO_VAT - Не облагается НДС;
  • •
    MANUAL - Ручной ввод НДС
Пример ответа 200 (ОК)
{
  "amount": 1.01,
  "bankComment": null,
  "bankStatus": "CREATED",
  "crucialFieldsHash": "e28b4eaf7cfbec683a665b1513681e02e49cff891b476c2b3e046c0d961e32b2",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "departmentalInfo": {
    "uip": "0",
    "drawerStatus101": "01",
    "kbk": "18210102010011000110",
    "oktmo": "45902000",
    "reasonCode106": "ТП",
    "taxPeriod107": "ГД.00.2021",
    "docNumber108": "000000000000001",
    "docDate109": "2021-12-14",
    "paymentKind110": "0"
  },
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "2",
  "number": "1",
  "operationCode": "01",
  "payeeAccount": "40702810564564564531",
  "payeeBankBic": "040173745",
  "payeeBankCorrAccount": "30101810800000000745",
  "payeeInn": "7723870785",
  "payeeKpp": "553453453",
  "payeeName": "Общество с ограниченной ответственностью \"Получатель\"",
  "payerAccount": "40702810600010800068",
  "payerBankBic": "044525593",
  "payerBankCorrAccount": "30101810200000000593",
  "payerInn": "7728168971",
  "payerKpp": "770801001",
  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
  "priority": "5",
  "purpose": "7736576798//772201001//Наименование третьего лица//Единый налоговый платеж. НДС не облагается",
  "urgencyCode": "NORMAL",
  "vat": {
    "rate": "0",
    "type": "NO_VAT"
  }
}
error
stringrequired

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

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
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": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
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"
}
Пример ответа 429 (Too Many Requests)
Нет тела ответа
error
stringrequired

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

error_description
stringoptional

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

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

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

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