B2B

Выставление счёта клиенту Альфа-Банка

Песочница
POST https://sandbox.alfabank.ru/api/payments/from-invoice
Пром
POST https://baas.alfabank.ru/api/payments/from-invoice
Scope

invoices

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

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
amount
numberrequired

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

date
stringrequired

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

deliveryKind
stringoptional

Вид платежа. Возможные значения: электронно. Если не заполнено, то будет присвоено значение электронно

expirationDate
stringoptional

Дата истечения заказа. Максимальное время жизни заказа - 30 минут

externalId
stringrequired

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

operationCode
stringoptional

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

  • •
    01 - платёжное поручение
orderNumber
stringoptional

Номер заказа

payeeAccount
stringrequired

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

payeeOrgIdHash
stringoptional

Идентификатор получателя платежа

paymentNumber
stringoptional

Номер платёжного поручения. Если поле не заполнено, то номер присваивается автоматически

priority
stringoptional

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

purpose
stringrequired

Назначение платежа. Максимальное количество символов - 210

urgencyCode
stringoptional

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

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

Данные НДС. Если объект не указан, то будут присвоены значения по умолчанию

rate
stringoptional

Ставка НДС. Возможные значения: 0, 10, 20. Значение по умолчанию: 0

type
stringrequired

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

  • •
    NO_VAT - не облагается НДС. При выборе этого значения в параметре purpose необходимо обязательно отправить "НДС не облагается";
  • •
    INCLUDED - НДС включён в сумму платежа. В параметре purpose необходимо указать посчитанное значение НДС, например: "В том числе НДС 10%, 100.00 руб.";
  • •
    ONTOP - НДС добавляется к сумме платежа. В параметре purpose необходимо указать посчитанное значение НДС, например: "Плюс 10% НДС, 100.00 руб.";
  • •
    MANUAL - ручной ввод НДС;
  • •
    AGENT - НДС исчисляется налоговым агентом.

Значение по умолчанию: NO_VAT

Пример запроса
Язык
1curl --location --request POST 'https://baas.alfabank.ru/api/payments/from-invoice' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data-raw '{
6  "amount": 1.01,
7  "date": "2018-12-31",
8  "deliveryKind": "электронно",
9  "expirationDate": null,
10  "externalId": "5863d914-80ee-4e27-9041-49e8136ab94e",
11  "operationCode": "01",
12  "orderNumber": "1",
13  "payeeAccount": "40807810201300000043",
14  "payeeOrgIdHash": null,
15  "paymentNumber": "1",
16  "priority": "5",
17  "purpose": "Оплата заказа №1. НДС не облагается",
18  "urgencyCode": "NORMAL",
19  "vat": {
20    "rate": "0",
21    "type": "NO_VAT"
22  }
23}'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "amount": 1.01,
3  "bankComment": null,
4  "bankStatus": "CREATED",
5  "crucialFieldsHash": "925a81c0d635559af364262b9ed5f0972c0bab64dd03189b511bc0e4cdc80d50",
6  "date": "2018-12-31",
7  "deliveryKind": "электронно",
8  "externalId": "5863d914-80ee-4e27-9041-49e8136ab94e",
9  "incomeTypeCode": null,
10  "number": "1",
11  "operationCode": "01",
12  "payeeAccount": "40807810201300000043",
13  "payeeBankBic": "044525593",
14  "payeeBankCorrAccount": "30101810200000000593",
15  "payeeInn": "7723870785",
16  "payeeKpp": "553453453",
17  "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
18  "payerAccount": null,
19  "payerBankBic": null,
20  "payerBankCorrAccount": null,
21  "payerInn": null,
22  "payerKpp": null,
23  "payerName": null,
24  "priority": "5",
25  "purpose": "Оплата заказа №1. НДС не облагается",
26  "urgencyCode": "NORMAL",
27  "vat": {
28    "rate": "0",
29    "type": "NO_VAT"
30  }
31}
BODY
атрибут
описание
amount
numberrequired

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

bankComment
stringoptional

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

bankStatus
stringoptional

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

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

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

date
stringrequired

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

deliveryKind
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

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

purpose
stringrequired

Назначение платежа. Максимальное количество символов - 210

urgencyCode
stringoptional

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

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

Данные НДС. Если объект не указан, то будут присвоены значения по умолчанию

rate
stringoptional

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

type
stringrequired

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

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

Значение по умолчанию: NO_VAT

Пример ответа 200 (OK)
1{
2  "amount": 1.01,
3  "bankComment": null,
4  "bankStatus": "CREATED",
5  "crucialFieldsHash": "925a81c0d635559af364262b9ed5f0972c0bab64dd03189b511bc0e4cdc80d50",
6  "date": "2018-12-31",
7  "deliveryKind": "электронно",
8  "externalId": "5863d914-80ee-4e27-9041-49e8136ab94e",
9  "incomeTypeCode": null,
10  "number": "1",
11  "operationCode": "01",
12  "payeeAccount": "40807810201300000043",
13  "payeeBankBic": "044525593",
14  "payeeBankCorrAccount": "30101810200000000593",
15  "payeeInn": "7723870785",
16  "payeeKpp": "553453453",
17  "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
18  "payerAccount": null,
19  "payerBankBic": null,
20  "payerBankCorrAccount": null,
21  "payerInn": null,
22  "payerKpp": null,
23  "payerName": null,
24  "priority": "5",
25  "purpose": "Оплата заказа №1. НДС не облагается",
26  "urgencyCode": "NORMAL",
27  "vat": {
28    "rate": "0",
29    "type": "NO_VAT"
30  }
31}
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 - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
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

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

  • •
    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
атрибут
описание
Нет тела ответа
BODY
атрибут
описание
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

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

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
BODY
атрибут
описание
Нет тела ответа
ВведениеКак работает сервис