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

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

Компаниям

Холдингам

/fintech/api/v1/pay-doc-cur/{externalId}

Запрос позволяет получить полные данные ранее созданного валютного платежного поручения (далее - ВПП).

Для получения полных данных ВПП необходимо отправить GET-запрос /fintech/api/v1/pay-doc-cur/{externalId} с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор документа (externalId) в path-параметре.

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

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

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

Request

/fintech/api/v1/pay-doc-cur/{externalId}

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
PATH PARAMETER
externalId	string	UUID	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	required	Идентификатор документа, присвоенный вами при его создании

GET /fintech/api/v1/pay-doc-cur/6a54593d-464b-4c8e-a7e2-742a05e5c241 HTTP/1.1
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678
Accept: */*

Responses

200 (OK)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
PayDocCur {
acceptDate	string	optional	Дата представления в банк ,
addInfo	string	optional	Примечание,
additionalInfo	string	optional	Информация получателю платежа (дополнительная информация), поле 72,
amountDebitTotal	number	optional	Фактическая сумма списанной валюты,
amountTransfer	AmountCurrency	required	Сумма перевода,
amountTransferTotal	number	optional	Фактическая сумма переведенной валюты ,
authPersonName	string	optional	ФИО ответственного лица,
authPersonTelfax	string	optional	Телефон ответственного лица,
b77info	string	optional	Информация для регулирующих органов,
bankComment	string	optional	Банковский комментарий к статусу документа,
bankStatus	string	optional	Статус документа,
beneficiaryAccount	string	optional	Счет бенефициара,
beneficiaryAddress	string	optional	Адрес бенефициара ,
beneficiaryBankAccount	string	optional	Корреспондентский счет банка бенефициара ,
beneficiaryBankAddress	string	optional	Адрес банка бенефициара,
beneficiaryBankBranchName	string	optional	Наименование филиала банка бенефициара,
beneficiaryBankClearingCode	ClearingCode	optional	Клиринговый код банка бенефициара,
beneficiaryBankCountryDigital	string	required	Цифровой код страны банка бенефициара,
beneficiaryBankCountryIso2	string	required	ISO-код страны банка бенефициара ,
beneficiaryBankName	string	required	Наименование банка бенефициара,
beneficiaryBankPlace	string	required	Местонахождение банка бенефициара,
beneficiaryBankSwift	string	optional	SWIFT-код банка бенефициара,
beneficiaryBeiCode	string	optional	BEI-код банка бенефициара,
beneficiaryCountryDigital	string	required	Цифровой код страны бенефициара,
beneficiaryCountryIso2	string	required	ISO-код страны бенефициара,
beneficiaryCountryName	string	optional	Наименование страны бенефициара на русском языке (краткое наименование),
beneficiaryInn	string	optional	ИНН бенефициара,
beneficiaryName	string	required	Наименование бенефициара,
beneficiaryPlace	string	required	Город (месторасположение) бенефициара,
chargesType	string	required	Тип комиссии за перевод,
codes23e	array[Code23e]	optional	23E: Код инструкции,
date	string	required	Дата составления документа,
digestSignatures	array[Signature]	optional	Электронные подписи по дайджесту документа,
externalId	string	required	Идентификатор документа, который вы присваиваете самостоятельно,
factRate	number	optional	Фактический курс конверсии,
iMediaBankAddress	string	optional	Адрес банка-посредника,
iMediaBankCountryDigital	string	optional	Цифровой код страны банка-посредника,
iMediaBankCountryIso2	string	optional	ISO-код страны банка-посредника,
iMediaBankName	string	optional	Наименование банка-посредника,
iMediaBankPlace	string	optional	Город банка-посредника,
iMediaBankSwift	string	optional	SWIFT-код банка-посредника,
iMediaClearingCode	ClearingCode	optional	Клиринговый код банка-посредника,
iMediaFilialBankName	string	optional	Наименование филиала банка-посредника,
inn	string	required	ИНН клиента,
linkedDocs	array[LinkedDoc]	optional	Связанные документы,
number	string	optional	Номер документа,
option50a	string	required	Опция 50а,
option56a	string	optional	Опция 56a,
option57a	string	required	Опция 57а,
option59a	string	optional	Опция 59а,
orgName	string	required	Сокращенное наименование организации клиента,
payerAccount	string	required	Счет плательщика,
payerAddress	string	required	Адрес плательщика,
payerBankBic	string	required	БИК банка плательщика,
payerBankPlace	string	optional	Местонахождение банка плательщика,
payerCountryDigital	string	required	Цифровой код страны перевододателя,
payerCountryIso2	string	required	ISO-код страны перевододателя,
payerCountryName	string	required	Наименование страны перевододателя на русском языке (краткое наименование),
payerName	string	required	Международное наименование плательщика,
payerPlace	string	required	Город (местонахождение) плательщика,
paymentDetails	string	required	Назначение платежа,
paymentDirection	string	required	Направление платежа (Платеж внутри или вне СБРФ),
rateAgree	boolean	required	С курсом проведения конверсионной операции согласны,
urgent	boolean	required	Срочность,
valueDate	string	optional	Дата валютирования/возврата
}
AmountCurrency {
amount	number	required	Сумма,
currencyCode	string	required	Цифровой код валюты,
currencyName	string	required	Буквенный ISO-код валюты
}
ClearingCode {
clearingCode	string	optional	Клиринговый код,
countryCode	string	optional	2-х символьный код страны,
shortName	string	optional	Сокращенное наименование национального клирингового кода,
symbol	string	optional	Обозначение национального клирингового кода
}
Code23e {
code	string	required	Код инструкции,
description	string	optional	Описание,
info	string	optional	Дополнительная информация
}
Signature {
base64Encoded	string	required	Значение электронной подписи (ЭП), закодированное в Base64,
certificateUuid	string	required	Уникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
docExtId	string	required	Идентификатор документа во внешней системе,
type	string	required	Тип связанного документа
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "acceptDate": "2018-12-31",
  "addInfo": "Примечание",
  "additionalInfo": "/CCTFDR/",
  "amountDebitTotal": 1.01,
  "amountTransfer": {
    "amount": 1.01,
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "amountTransferTotal": 1.01,
  "authPersonName": "Иванов Иван Иванович",
  "authPersonTelfax": "4955005550",
  "b77info": "/BENEFRES/",
  "bankComment": "string",
  "bankStatus": "string",
  "beneficiaryAccount": "40802840600000200000",
  "beneficiaryAddress": "UL.KUTUZOVSKAYA,D.2",
  "beneficiaryBankAccount": "40802840600000200000",
  "beneficiaryBankAddress": "3, AVENUE HOCHE",
  "beneficiaryBankBranchName": "(TREASURY DEPARTMENT)",
  "beneficiaryBankClearingCode": {
    "clearingCode": "BLAAAOLU",
    "countryCode": "DE",
    "shortName": "German Bankleitzahl (BLZ)",
    "symbol": "BL"
  },
  "beneficiaryBankCountryDigital": "643",
  "beneficiaryBankCountryIso2": "RU",
  "beneficiaryBankName": "ALANDSBANKEN ABP (FINLAND),SVENSK FILIAL",
  "beneficiaryBankPlace": "ФИНЛЯНДИЯ",
  "beneficiaryBankSwift": "AABAFI22TMS",
  "beneficiaryBeiCode": "UBSWUS33CHI",
  "beneficiaryCountryDigital": "643",
  "beneficiaryCountryIso2": "RU",
  "beneficiaryCountryName": "РОССИЯ",
  "beneficiaryInn": "7707083893",
  "beneficiaryName": "EMIRP",
  "beneficiaryPlace": "MOSCOW",
  "chargesType": "BEN",
  "codes23e": [
    {
      "code": "SDVA",
      "description": "Средства должны быть зачислены бенефициару той же датой валютирования",
      "info": "DOPOLNITEL INFO 8747483893"
    }
  ],
  "date": "2018-12-31",
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "factRate": 1.0001,
  "iMediaBankAddress": "ACCIONES Y VALORES, PISO 12:CALLE 72 7 64",
  "iMediaBankCountryDigital": "643",
  "iMediaBankCountryIso2": "RU",
  "iMediaBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
  "iMediaBankPlace": "LUANDA",
  "iMediaBankSwift": "BDAAAOLU",
  "iMediaClearingCode": {
    "clearingCode": "BLAAAOLU",
    "countryCode": "DE",
    "shortName": "German Bankleitzahl (BLZ)",
    "symbol": "BL"
  },
  "iMediaFilialBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
  "inn": "7707083893",
  "linkedDocs": [
    {
      "docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
      "type": "ExportContractInsure"
    }
  ],
  "number": "1",
  "option50a": "K",
  "option56a": "A",
  "option57a": "A",
  "option59a": "A",
  "orgName": "ООО \"Организация\"",
  "payerAccount": "40802840600000200000",
  "payerAddress": "UL.DOBROLIUBOVA,D.18,OF.III",
  "payerBankBic": "044525225",
  "payerBankPlace": "MOSCOW",
  "payerCountryDigital": "643",
  "payerCountryIso2": "RU",
  "payerCountryName": "РОССИЯ",
  "payerName": "LLC COMPANY",
  "payerPlace": "MOSKVA",
  "paymentDetails": "CONTRACT 123",
  "paymentDirection": "0",
  "rateAgree": false,
  "urgent": false,
  "valueDate": "2018-12-31"
}

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request запроса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Ошибка валидации	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request запроса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
  
{
    "cause": "VALIDATION_FAULT",
    "referenceId": "0d6a80ba-7d35-4858-8443-9a77039ad9f1",
    "message": "Параметр \"externalId\" не соответствует регулярному выражению: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
    "checks": [],
    "fieldNames": null
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959-bbd5-490a-9f9f-67fb7380fae5-2"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция PAY_DOC_CUR. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

404 (Not found)

Cause	Message	Description
NOT_FOUND	Документ с указанным ID не найден

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
  
{
    "cause": "NOT_FOUND",
    "referenceId": "1bd1b8b9-1bd3-4159-9909-d30536211114",
    "message": "Документ с указанным ID не найден"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice{
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

json HTTP/1.1 429 Too Many Requests Content-Type: application/json;charset=UTF-8

{ "cause": " TOO_MANY_REQUESTS ", "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61", "message": " Превышен лимит запросов. Повторите операцию позже" }

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}