Создание исходящего платежного требования

Обновлено 28 марта 2025

POST

/v1/payment-requests/outgoing/in

Создание исходящего платежного требования

Запрос

Header Parameters

Authorization
string
required
Access token организации-клиента, полученный через SSO
Example: f8ad3141-b7e8-4924-92de-3de4fd0a464e-1

• application/json

Body

required

Запрос на создание исходящего платежного требования

acceptanceTerm

string

Значение должно соответствовать регулярному выражению ^[1-5]{1}$

Срок для акцепта (поле 36). Указывается количество дней для получения акцепта плательщика

amount

number

required

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

crucialFieldsHash

string

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

date

date

required

Дата составления документа

deliveryKind

string

Значение должно соответствовать регулярному выражению ^(электронно|срочно|0)$

Вид платежа

digestSignatures

object[]

Электронные подписи по дайджесту документа

Array [

certificateUuid

uuid

required

Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)

base64Encoded

string

required

Возможные значения: non-empty

Значение электронной подписи, закодированное в Base64

]

externalId

uuid

required

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

number

string

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

operationCode

string

required

Значение должно соответствовать регулярному выражению ^02$

Код операции

payeeAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

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

payeeBankBic

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{9}$

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

payeeBankCorrAccount

string

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

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

payeeInn

string

Значение должно соответствовать регулярному выражению ^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$

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

payeeName

string

required

Возможные значения: <= 160 characters

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

payerAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

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

payerBankBic

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{9}$

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

payerBankCorrAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

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

payerInn

string

required

Значение должно соответствовать регулярному выражению ^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$

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

payerName

string

required

Возможные значения: <= 160 characters

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

paymentCondition

string

required

Значение должно соответствовать регулярному выражению ^(1|2)$

Условие оплаты (поле 35). Указывается цифра "1" - заранее данный акцепт плательщика или цифра "2" - требуется получение акцепта плательщика

priority

string

required

Значение должно соответствовать регулярному выражению ^[1-5]{1}$

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

purpose

string

required

Возможные значения: <= 210 characters

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

vat

object

nullable

Данные НДС

type

string

nullable

required

Возможные значения: [INCLUDED, ONTOP, NO_VAT, MANUAL]

Способ расчета НДС

rate

string

nullable

Значение должно соответствовать регулярному выражению ^(0|5|7|10|20)$

Ставка НДС

amount

number

nullable

Сумма НДС

voCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{5}$

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

Ответы

• 201
• 202
• 400
• 401
• 403
• 415
• 429
• 500
• 503

Создан

• application/json

• Схема
• Пример из схемы

Schema

acceptanceTerm

string

Значение должно соответствовать регулярному выражению ^[1-5]{1}$

Срок для акцепта (поле 36). Указывается количество дней для получения акцепта плательщика

amount

number

required

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

bankStatus

string

Статус документа

bankComment

string

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

crucialFieldsHash

string

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

date

date

required

Дата составления документа

deliveryKind

string

Значение должно соответствовать регулярному выражению ^(электронно|срочно|0)$

Вид платежа

digestSignatures

object[]

Электронные подписи по дайджесту документа

Array [

certificateUuid

uuid

required

Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)

base64Encoded

string

required

Возможные значения: non-empty

Значение электронной подписи, закодированное в Base64

]

externalId

uuid

required

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

number

string

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

operationCode

string

required

Значение должно соответствовать регулярному выражению ^02$

Код операции

payeeAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

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

payeeBankBic

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{9}$

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

payeeBankCorrAccount

string

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

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

payeeInn

string

Значение должно соответствовать регулярному выражению ^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$

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

payeeName

string

required

Возможные значения: <= 160 characters

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

payerAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

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

payerBankBic

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{9}$

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

payerBankCorrAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

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

payerInn

string

required

Значение должно соответствовать регулярному выражению ^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$

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

payerName

string

required

Возможные значения: <= 160 characters

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

paymentCondition

string

required

Значение должно соответствовать регулярному выражению ^(1|2)$

Условие оплаты (поле 35). Указывается цифра "1" - заранее данный акцепт плательщика или цифра "2" - требуется получение акцепта плательщика

priority

string

required

Значение должно соответствовать регулярному выражению ^[1-5]{1}$

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

purpose

string

required

Возможные значения: <= 210 characters

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

vat

object

nullable

Данные НДС

type

string

nullable

required

Возможные значения: [INCLUDED, ONTOP, NO_VAT, MANUAL]

Способ расчета НДС

rate

string

nullable

Значение должно соответствовать регулярному выражению ^(0|5|7|10|20)$

Ставка НДС

amount

number

nullable

Сумма НДС

voCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{5}$

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

{
  "acceptanceTerm": "string",
  "amount": "1.01",
  "bankStatus": "string",
  "bankComment": "string",
  "crucialFieldsHash": "string",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "digestSignatures": [
    {
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w=="
    }
  ],
  "externalId": "9b9f1b57-425e-4aff-9856-21fc4951f1e8",
  "number": 1,
  "operationCode": "02",
  "payeeAccount": "40802810600000200000",
  "payeeBankBic": "044525225",
  "payeeBankCorrAccount": "30101810400000000225",
  "payeeInn": "7707083893",
  "payeeName": "Общество с ограниченной ответственностью Клиент",
  "payerAccount": "40802810600000200000",
  "payerBankBic": "044525225",
  "payerBankCorrAccount": "30101810400000000225",
  "payerInn": 7707083893,
  "payerName": "Общество с ограниченной ответственностью Клиент",
  "paymentCondition": "string",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "vat": {
    "type": "NO_VAT",
    "rate": 10,
    "amount": 1.01
  },
  "voCode": "61150"
}

Операция не завершена полностью

• application/json

• Схема
• Пример из схемы

Schema

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "string"
}

Ошибка в запросе

• application/json

• Схема
• Пример из схемы

Schema

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "string"
}

Не авторизован

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Операция не может быть выполнена: доступ к ресурсу запрещен

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact Serialization

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Превышен лимит запросов

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Внутренняя ошибка сервера

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Сервис временно недоступен

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Loading...

Loading...