ym88659208ym87991671
Создание валютного платежного поручения | Документация для разработчиков

Создание валютного платежного поручения

Обновлено 29 ноября 2024

Alt text /fintech/api/v1/pay-doc-cur

Ресурс позволяет создать валютное платежное поручение.

Для создания валютного платежного поручения необходимо отправить POST-запрос /fintech/api/v1/pay-doc-cur с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами документа в теле запроса.

В параметре scope ссылки авторизации пользователя должен быть указан сервис PAY_DOC_CUR для получения доступа к этому запросу.

  • Если в запросе на создание документа передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
  • Если в запросе не передавать ЭП к документу, то документ будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.

Для обращения к ресурсу необходимо отправлять запрос на:

  • Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443
  • Промышленный контур https://fintech.sberbank.ru:9443

Request

/fintech/api/v1/pay-doc-cur
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
BODY
PayDocCur {
  addInfostringstring^.{1,300}$optionalПримечание,
  additionalInfostringstring^.{1,220}$optionalИнформация получателю платежа (дополнительная информация), поле 72,
  amountTransferAmountCurrencyobjectrequiredСумма перевода,
  authPersonNamestringstring^.{1,60}$optionalФИО ответственного лица,
  authPersonTelfaxstringstring^.{1,40}$optionalТелефон ответственного лица,
  b77infostringstring^.{1,109}$optionalИнформация для регулирующих органов,
  beneficiaryAccountstringISO 13616^[0-9]{1,34}$optionalСчет бенефициара,
  beneficiaryAddressstringstring???optionalАдрес бенефициара ,
  beneficiaryBankAccountstringstring???optionalКорреспондентский счет банка бенефициара ,
  beneficiaryBankAddressstringstring^.{1,255}$optionalАдрес банка бенефициара,
  beneficiaryBankBranchNamestringstring^.{1,70}$optionalНаименование филиала банка бенефициара,
  beneficiaryBankClearingCodeClearingCodeobjectoptionalКлиринговый код банка бенефициара,
  beneficiaryBankCountryDigitalstringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country
requiredЦифровой код страны банка бенефициара,
  beneficiaryBankCountryIso2stringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника Country
requiredISO-код страны банка бенефициара ,
  beneficiaryBankNamestringstring^.{1,140}$requiredНаименование банка бенефициара,
  beneficiaryBankPlacestringstring^.{1,255}$requiredМестонахождение банка бенефициара,
  beneficiaryBankSwiftstringBIC-код^([0-9]{8}|[0-9]{11})$optionalSWIFT-код банка бенефициара,
  beneficiaryBeiCodestringBEI-код^[0-9]{11}$optionalBEI-код банка бенефициара,
  beneficiaryCountryDigitalstringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country
requiredЦифровой код страны бенефициара,
  beneficiaryCountryIso2stringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника Country
requiredISO-код страны бенефициара,
  beneficiaryCountryNamestringstring^.{1,255}$optionalНаименование страны бенефициара на русском языке (краткое наименование),
  beneficiaryInnstringstring^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$optionalИНН бенефициара.

Не заполняется при paymentDirection \= 0,
  beneficiaryNamestringstring^.{1,140}$requiredНаименование бенефициара,
  beneficiaryPlacestringstring^.{1,35}$requiredГород (месторасположение) бенефициара,
  chargesTypestringstring^(BEN|SHA|OUR)$requiredТип комиссии за перевод.

BEN - ;
SHA - ;
* OUR - ,
  codes23earray[Code23e]arrayoptional23E: Код инструкции,
  datestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата составления документа,
  digestSignaturesarray[Signature]arrayoptionalЭлектронные подписи по дайджесту документа.

Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу.
Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СберБизнес.

О подписании дайджеста платежного документа подробно рассказали в соответствующем разделе документации.
  externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, который вы присваиваете самостоятельно,
  iMediaBankAddressstringstring^.{1,255}$optionalАдрес банка-посредника,
  iMediaBankCountryDigitalstringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country
optionalЦифровой код страны банка-посредника,
  iMediaBankCountryIso2stringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника Country
optionalISO-код страны банка-посредника,
  iMediaBankNamestringstring^.{1,140}$optionalНаименование банка-посредника,
  iMediaBankPlacestringstring^.{1,35}$optionalГород банка-посредника,
  iMediaBankSwiftstringBIC-код^([0-9]{8}|[0-9]{11})$optionalSWIFT-код банка-посредника,
  iMediaClearingCodeClearingCodeobjectoptionalКлиринговый код банка-посредника,
  iMediaFilialBankNamestringstring???optionalНаименование филиала банка-посредника,
  innstringstring^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$requiredИНН клиента,
  linkedDocsarray[LinkedDoc]arrayoptionalСвязанные документы,
  numberstringstring^[0-9]{1,7}$optionalНомер документа,
  option50astringstring^(K|F)$requiredОпция 50а.

K - ;
F - ,
  option56astringstring^(A|D)$optionalОпция 56a.

A - ;
**D** - ,
  option57astringstring^(A|D)$requiredОпция 57а.

A - ;
D - ,
  option59astringstring^(A|F)$optionalОпция 59а.

A - ;
F - ,
  orgNamestringstring^.{1,160}$requiredСокращенное наименование организации клиента,
  payerAccountstringstring^[0-9]{20}$requiredСчет плательщика,
  payerAddressstringstring^.{1,120}$requiredАдрес плательщика,
  payerBankBicstringstring^[0-9]{9}$requiredБИК банка плательщика,
  payerBankPlacestringstring^.{1,35}$optionalМестонахождение банка плательщика,
  payerCountryDigitalstringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country
requiredЦифровой код страны перевододателя,
  payerCountryIso2stringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника Country
requiredISO-код страны перевододателя,
  payerCountryNamestringstring^.{1,255}$requiredНаименование страны перевододателя на русском языке (краткое наименование),
  payerNamestringstring^.{1,140}$requiredМеждународное наименование плательщика,
  payerPlacestringstring^.{1,35}$requiredГород (местонахождение) плательщика,
  paymentDetailsstringstring^.{1,140}$requiredНазначение платежа,
  paymentDirectionstringstring^(0|1)$requiredНаправление платежа (Платеж внутри или вне СБРФ).

1 - внутри;
0 - вне,
  rateAgreebooleanboolean^(true|false)$requiredС курсом проведения конверсионной операции согласны,
  urgentbooleanboolean^(true|false)$requiredСрочность.

Значение true необходимо отправлять в случае, если по счету списания есть возможность отправлять неотложные платежи
}
AmountCurrency {
  amountnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredСумма,
  currencyCodestringISO 4217^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника CurDict
requiredЦифровой код валюты,
  currencyNamestringISO 4217^[A-Z]{3}$

Актуальный список значений можно получить с помощью справочника CurDict
requiredБуквенный ISO-код валюты
}
ClearingCode {
  clearingCodestringНКС^.{1,11}$ ???optionalКлиринговый код,
  countryCodestringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника ClearingStructure
optionalISO-код код страны,
  shortNamestringНКС^.{1,140}$

Актуальный список значений можно получить с помощью справочника ClearingStructure
optionalСокращенное наименование национального клирингового кода,
  symbolstringНКС^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника ClearingStructure
optionalОбозначение национального клирингового кода,
}
Code23e {
  codestringstring^[A-Z]{4}$

Актуальный список значений можно получить с помощью справочника Instruction23
requiredКод инструкции,
  descriptionstringstring^.{1,255}$optionalОписание,
  infostringstring^.{1,30}$optionalДополнительная информация
}
Signature {
  base64Encodedstringbase64^[a-zA-Z0-9]+$requiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateUuidstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа во внешней системе,
  typestringstring^[a-zA-Z0-9. \ _ -]{1,50}$requiredТип связанного документа
}

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
PayDocCur {
  acceptDatestringoptionalДата представления в банк ,
  addInfostringoptionalПримечание,
  additionalInfostringoptionalИнформация получателю платежа (дополнительная информация), поле 72,
  amountDebitTotalnumberoptionalФактическая сумма списанной валюты,
  amountTransferAmountCurrencyrequiredСумма перевода,
  amountTransferTotalnumberoptionalФактическая сумма переведенной валюты ,
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  b77infostringoptionalИнформация для регулирующих органов,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  beneficiaryAccountstringoptionalСчет бенефициара,
  beneficiaryAddressstringoptionalАдрес бенефициара ,
  beneficiaryBankAccountstringoptionalКорреспондентский счет банка бенефициара ,
  beneficiaryBankAddressstringoptionalАдрес банка бенефициара,
  beneficiaryBankBranchNamestringoptionalНаименование филиала банка бенефициара,
  beneficiaryBankClearingCodeClearingCodeoptionalКлиринговый код банка бенефициара,
  beneficiaryBankCountryDigitalstringrequiredЦифровой код страны банка бенефициара,
  beneficiaryBankCountryIso2stringrequiredISO-код страны банка бенефициара ,
  beneficiaryBankNamestringrequiredНаименование банка бенефициара,
  beneficiaryBankPlacestringrequiredМестонахождение банка бенефициара,
  beneficiaryBankSwiftstringoptionalSWIFT-код банка бенефициара,
  beneficiaryBeiCodestringoptionalBEI-код банка бенефициара,
  beneficiaryCountryDigitalstringrequiredЦифровой код страны бенефициара,
  beneficiaryCountryIso2stringrequiredISO-код страны бенефициара,
  beneficiaryCountryNamestringoptionalНаименование страны бенефициара на русском языке (краткое наименование),
  beneficiaryInnstringoptionalИНН бенефициара,
  beneficiaryNamestringrequiredНаименование бенефициара,
  beneficiaryPlacestringrequiredГород (месторасположение) бенефициара,
  chargesTypestringrequiredТип комиссии за перевод,
  codes23earray[Code23e]optional23E: Код инструкции,
  datestringrequiredДата составления документа,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно,
  factRatenumberoptionalФактический курс конверсии,
  iMediaBankAddressstringoptionalАдрес банка-посредника,
  iMediaBankCountryDigitalstringoptionalЦифровой код страны банка-посредника,
  iMediaBankCountryIso2stringoptionalISO-код страны банка-посредника,
  iMediaBankNamestringoptionalНаименование банка-посредника,
  iMediaBankPlacestringoptionalГород банка-посредника,
  iMediaBankSwiftstringoptionalSWIFT-код банка-посредника,
  iMediaClearingCodeClearingCodeoptionalКлиринговый код банка-посредника,
  iMediaFilialBankNamestringoptionalНаименование филиала банка-посредника,
  innstringrequiredИНН клиента,
  linkedDocsarray[LinkedDoc]optionalСвязанные документы,
  numberstringoptionalНомер документа,
  option50astringrequiredОпция 50а,
  option56astringoptionalОпция 56a,
  option57astringrequiredОпция 57а,
  option59astringoptionalОпция 59а,
  orgNamestringrequiredСокращенное наименование организации клиента,
  payerAccountstringrequiredСчет плательщика,
  payerAddressstringrequiredАдрес плательщика,
  payerBankBicstringrequiredБИК банка плательщика,
  payerBankPlacestringoptionalМестонахождение банка плательщика,
  payerCountryDigitalstringrequiredЦифровой код страны перевододателя,
  payerCountryIso2stringrequiredISO-код страны перевододателя,
  payerCountryNamestringrequiredНаименование страны перевододателя на русском языке (краткое наименование),
  payerNamestringrequiredМеждународное наименование плательщика,
  payerPlacestringrequiredГород (местонахождение) плательщика,
  paymentDetailsstringrequiredНазначение платежа,
  paymentDirectionstringrequiredНаправление платежа (Платеж внутри или вне СБРФ),
  rateAgreebooleanrequiredС курсом проведения конверсионной операции согласны,
  urgentbooleanrequiredСрочность,
  valueDatestringoptionalДата валютирования/возврата
}
AmountCurrency {
  amountnumberrequiredСумма,
  currencyCodestringrequiredЦифровой код валюты,
  currencyNamestringrequiredБуквенный ISO-код валюты
}
ClearingCode {
  clearingCodestringoptionalКлиринговый код,
  countryCodestringoptional2-х символьный код страны,
  shortNamestringoptionalСокращенное наименование национального клирингового кода,
  symbolstringoptionalОбозначение национального клирингового кода
}
Code23e {
  codestringrequiredКод инструкции,
  descriptionstringoptionalОписание,
  infostringoptionalДополнительная информация
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateUuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringrequiredИдентификатор документа во внешней системе,
  typestringrequiredТип связанного документа
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request запроса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request запроса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
НаименованиеТипОбязательностьОписание
ResourceFault {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
  checksarray[Check]optionalСписок проверок, приведших к ошибке,
  fieldNamesarray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
  levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
  messagestringoptionalСообщение,
  fieldsarray[string]optionalНазвания полей (при наличии связи с моделью)
}
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция PAY_DOC_RU. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
429 (Too Many Requests)
CauseMessageDescription
TOO_MANY_REQUESTSПревышен лимит запросов. Повторите операцию позже.Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее
НаименованиеТипОбязательностьОписание
Notice{
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.