B2BH2H

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

Песочница
GET https://sandbox.alfabank.ru/api/jp/v2/payments/{externalId}
Пром
GET https://baas.alfabank.ru/api/jp/v2/payments/{externalId}
Scope

payment

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

application/json

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

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

Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v2/payments/{externalId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "amount": 1,
3  "bankComment": "",
4  "bankStatus": "CREATED",
5  "crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316",
6  "date": "2022-10-11",
7  "deliveryKind": "электронно",
8  "departmentalInfo": {
9    "uip": "0",
10    "drawerStatus101": "01",
11    "kbk": "18210102010011000110",
12    "oktmo": "45902000",
13    "reasonCode106": "ТП",
14    "taxPeriod107": "МС.02.2022",
15    "docNumber108": "000000000000001",
16    "docDate109": "2022-05-25"
17  },
18  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
19  "number": "1047",
20  "operationCode": "01",
21  "payeeAccount": "40702810564564564531",
22  "payeeBankBic": "040173745",
23  "payeeBankCorrAccount": "30101810800000000745",
24  "payeeInn": "7723870785",
25  "payeeKpp": "553453453",
26  "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
27  "payerAccount": "40702810102300000001",
28  "payerBankBic": "044525593",
29  "payerBankCorrAccount": "30101810200000000593",
30  "payerInn": "0453438040",
31  "payerKpp": "046773311",
32  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
33  "priority": "5",
34  "purpose": "Оплата заказа №1. НДС не облагается",
35  "urgencyCode": "NORMAL",
36  "vat": {
37    "rate": "0",
38    "type": "NO_VAT"
39  }
40}
BODY
атрибут
описание
amount
numberrequired

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

bankComment
stringoptional

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

bankStatus
stringoptional

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

  • •
    ACCEPTED - принят;
  • •
    CREATED - создан;
  • •
    PARTSIGNED - отправлен на подпись или частично подписан;
  • •
    SIGNED - подписан;
  • •
    CARD2 - ожидает оплаты;
  • •
    DELETED - удалён;
  • •
    REFUSEDBYBANK - отвергнут банком;
  • •
    REQUISITEERROR - ошибка реквизитов;
  • •
    IMPLEMENTED - исполнен

Примечание: статус IMPLEMENTED не всегда окончательный - после перехода в этот статус платёж может автоматически перейти в REFUSEDBYBANK, например, если банк-получатель отклонит зачисление из-за неверных реквизитов получателя. Рекомендуется продолжать опрашивать API в течение 15 минут после получения статуса 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
stringoptional

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

payerBankBic
stringoptional

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

payerBankCorrAccount
stringoptional

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

payerInn
stringoptional

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

payerKpp
stringoptional

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

payerName
stringoptional

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

priority
stringrequired

Очерёдность платежа. Принимает возможные значения:

  • •
    1 - алиментные удержания из заработной платы, компенсации вреда жизни и здоровью;
  • •
    2 - погашение задолженностей по зарплатам сотрудникам, выплаты выходных пособий и авторских вознаграждений;
  • •
    3 - выплаты зарплат сотрудникам по трудовым соглашениям, принудительная уплата налогов и отчислений во внебюджетные фонды;
  • •
    4 - принудительные выплаты, которые не вошли в первую, вторую и третью очередь, например, задолженности по договорам, штрафы, неустойки, коммунальные платежи;
  • •
    5 - все остальные, не вошедшие в первую, вторую, третью и четвёртую категории, например, добровольная уплата долгов, пеней, штрафов
purpose
stringrequired

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

urgencyCode
stringoptional

Код срочности:

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

Данные НДС

rate
stringoptional

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

type
stringrequired

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

  • •
    INCLUDED - НДС включён в сумму платежа;
  • •
    NO_VAT - не облагается НДС;
  • •
    MANUAL - ручной ввод НДС;
  • •
    ONTOP - НДС добавляется к сумме платежа;
  • •
    AGENT - НДС исчисляется налоговым агентом
objectoptional

Сведения о валютной операции

contractNumber
stringrequired

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

contractDate
stringrequired

Дата контракта

voCode
stringrequired

Код валютной операции

comment
stringoptional

Примечание

nonResidentRecipientName
stringoptional

Наименование получателя в другой стране

nonResidentAccountNumber
stringoptional

Счёт получателя в другой стране

swift
stringoptional

SWIFT-код банка получателя

Пример ответа 200 (OK) 
1{
2  "amount": 1,
3  "bankComment": "",
4  "bankStatus": "CREATED",
5  "crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316",
6  "date": "2022-10-11",
7  "deliveryKind": "электронно",
8  "departmentalInfo": {
9    "uip": "0",
10    "drawerStatus101": "01",
11    "kbk": "18210102010011000110",
12    "oktmo": "45902000",
13    "reasonCode106": "ТП",
14    "taxPeriod107": "МС.02.2022",
15    "docNumber108": "000000000000001",
16    "docDate109": "2022-05-25"
17  },
18  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
19  "number": "1047",
20  "operationCode": "01",
21  "payeeAccount": "40702810564564564531",
22  "payeeBankBic": "040173745",
23  "payeeBankCorrAccount": "30101810800000000745",
24  "payeeInn": "7723870785",
25  "payeeKpp": "553453453",
26  "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
27  "payerAccount": "40702810102300000001",
28  "payerBankBic": "044525593",
29  "payerBankCorrAccount": "30101810200000000593",
30  "payerInn": "0453438040",
31  "payerKpp": "046773311",
32  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
33  "priority": "5",
34  "purpose": "Оплата заказа №1. НДС не облагается",
35  "urgencyCode": "NORMAL",
36  "vat": {
37    "rate": "0",
38    "type": "NO_VAT"
39  }
40}
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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 - эндпоинт не найден или неактивен;
  • •
    not_found - платёж не найден или пока не исполнен
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

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

  • •
    conflict - платёжное поручение с таким externalId уже существует
error_description
stringoptional

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

Пример ошибки 409 (Conflict) 
1{
2  "error": "conflict",
3  "error_description": "Request could not be processed because of conflict in the request"
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}
Нет тела ответа

Отправьте письмо на alfa_api@alfabank.ru, указав следующие данные:

  1. 1.
    client_id.
  2. 2.
    Дата и время запроса с указанием часового пояса.
  3. 3.
    Метод и URI запроса.
  4. 4.
    Заголовки и тело запроса.
  5. 5.
    Полученная ошибка и заголовки ответа, включая X-TraceId.
  6. 6.
    IP-адрес, с которого был отправлен запрос.
Получение статуса платёжного порученияПолучение печатной формы платёжного поручения в Base64