H2H

Загрузка поручений

Песочница
POST https://sandbox.alfabank.ru/api/aff/jp/v1/payments
Пром
POST https://baas.alfabank.ru/api/aff/jp/v1/payments
Scope

factoring

Описание

Метод позволяет загрузить одно платёжное поручение для последующей отправки в банк на финансирование.

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

application/json

Content-Type
stringrequired

application/json

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

Идентификатор платёжного поручения в ERP-системе в формате UUID

objectrequired

Данные принципала

name
stringrequired

Наименование принципала

inn
stringrequired

ИНН принципала

kpp
stringoptional

КПП принципала. Для юридических лиц (ИНН 10 символов) поле обязательное

orderType
stringrequired

Тип платёжного поручения. Возможные значения:

  • •
    BUDGET;
  • •
    NONBUDGET
objectrequired

Данные кредитора

name
stringrequired

Наименование кредитора

inn
stringrequired

ИНН кредитора

kpp
stringoptional

КПП кредитора. Для юридических лиц (ИНН 10 символов) поле обязательное. Если orderType = BUDGET, то поле обязательное

ogrn
stringoptional

ОГРН кредитора

bankName
stringrequired

Наименование банка кредитора

bankBIC
stringrequired

БИК банка кредитора

bankCorrAccountNumber
stringrequired

Корреспондентский счёт банка кредитора

accountNumber
stringrequired

Расчётный счёт кредитора

kbk
stringoptional

КБК кредитора (104). В случае, если orderType = BUDGET, то поле обязательное

oktmo
stringoptional

ОКТМО кредитора (105). В случае, если orderType = BUDGET, то поле обязательное

contractNumber
stringoptional

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

contractDate
dateoptional

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

monetaryClaimId
stringoptional

Идентификатор денежного требования

monetaryClaimAmount
numberrequired

Сумма денежного требования

compensationPeriod
stringrequired

Период компенсации (в днях)

paymentPurpose
stringrequired

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

fixedRatePercentage
numberoptional

Фиксированная ставка (% годовых)

floatRatePercentage
numberoptional

Надбавка плавающей ставки (% пунктов)

currencyCode
stringrequired

Код валюты. Возможные значения:

  • •
    RUR - российский рубль;
  • •
    USD - доллар США;
  • •
    EUR - евро;
  • •
    CNY - юань;
  • •
    JPY - йена;
  • •
    AZN - азербайджанский манат;
  • •
    AMD - армянский драм;
  • •
    BYN - белорусский рубль;
  • •
    KZT - тенге;
  • •
    KGS - сом;
  • •
    MDL - молдавский лей;
  • •
    TJS - сомони;
  • •
    UZS - узбекский сум;
  • •
    TRY - турецкая лира;
  • •
    INR - индийская рупия;
  • •
    AED - дирхам ОАЭ
paymentPriority
stringoptional

Очерёдность платежа. В случае, если orderType = BUDGET, то поле обязательное

payerStatus
stringoptional

Статус плательщика (101). В случае, если orderType = BUDGET, то поле обязательное

accrualUniqueId
stringoptional

Уникальный идентификатор начисления, УИН (22). В случае, если orderType = BUDGET, то поле обязательное

taxPaymentCode
stringoptional

Код основания налогового платежа (106). В случае, если orderType = BUDGET, то поле обязательное

taxPeriod
stringoptional

Налоговый период (107). В случае, если orderType = BUDGET, то поле обязательное

baseDocumentType
stringoptional

Документ-основание (108). В случае, если orderType = BUDGET, то поле обязательное

baseDocumentDate
stringoptional

Дата документа-основания (109). В случае, если orderType = BUDGET, то поле обязательное

Пример запроса
Язык 
1curl --location 'https://baas.alfabank.ru/api/aff/jp/v1/payments' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "externalId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
7  "principalInfo": {
8    "name": "ООО Пример",
9    "inn": "7707083893",
10    "kpp": "773601001"
11  },
12  "orderType": "BUDGET",
13  "creditorInfo": {
14    "name": "ООО Кредитор",
15    "inn": "7707083893",
16    "kpp": "773601001",
17    "ogrn": "1027700132195",
18    "bankName": "Банк Пример",
19    "bankBIC": "044525225",
20    "bankCorrAccountNumber": "30101810400000000225",
21    "accountNumber": "40702810500000000001"
22  },
23  "kbk": "18210102010011000110",
24  "oktmo": "45384000",
25  "contractNumber": "12345",
26  "contractDate": "2023-05-10",
27  "monetaryClaimId": "claim-123",
28  "monetaryClaimAmount": 100000.5,
29  "compensationPeriod": "30",
30  "paymentPurpose": "Оплата за услуги",
31  "fixedRatePercentage": 5.5,
32  "floatRatePercentage": 1.25,
33  "currencyCode": "RUR",
34  "paymentPriority": "5",
35  "payerStatus": "101",
36  "accrualUniqueId": "22-1234567890",
37  "taxPaymentCode": "106",
38  "taxPeriod": "2021",
39  "baseDocumentType": "Счёт",
40  "baseDocumentDate": "2023-04-01"
41}'
Параметры ответа
Пример ответа 201 (Created) 
1{
2  "externalId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3  "paymentId": "h7d6c70b-5d5c-4542-n207-4g83bj45u579"
4}
BODY
атрибут
описание
externalId
stringrequired

Идентификатор платёжного поручения в ERP-системе в формате UUID

paymentId
stringrequired

Идентификатор платёжного поручения в банке в формате UUID

Пример ответа 201 (Created) 
1{
2  "externalId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3  "paymentId": "h7d6c70b-5d5c-4542-n207-4g83bj45u579"
4}
BODY
атрибут
описание
error
stringrequired

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

  • •
    invalid_request - неверные входные параметры запроса
error_description
stringrequired

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

Пример ошибки 400 (Bad Request) 
1{
2  "error": "invalid_request",
3  "error_description": "An already created payment order with this identifier was found"
4}
BODY
атрибут
описание
error
stringrequired

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

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
error_description
stringrequired

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

Пример ошибки 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
stringrequired

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

Пример ошибки 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

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

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

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

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