Получение документа 'Валютное платежное поручение'
/v1/pay-doc-cur/{externalId}
Возвращает полные данные ранее созданного валютного платежного поручения. Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор документа (externalId), указанный при его создании.
Для доступа к этому методу в параметре scope
ссылки авторизации пользователя должен быть указан сервис PAY_DOC_CUR
.
Запрос
Path Parameters
Уникальный идентификатор документа, присвоенный партнером
Успешное выполнение запроса
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Array [
]
Array [
]
Статус документа
Банковский комментарий к статусу документа
Возможные значения: <= 300 characters
Примечание
Возможные значения: <= 220 characters
Информация получателю платежа
amountTransfer
object
Возможные значения: >= 0.01
Сумма
Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$
Цифровой код валюты
Возможные значения: Value must match regular expression ^[A-Z]{3}$
Буквенный ISO-код валюты
Возможные значения: <= 60 characters
ФИО ответственного лица
Возможные значения: <= 40 characters
Телефон ответственного лица
Возможные значения: <= 109 characters
Информация для регулирующих органов
Возможные значения: <= 34 characters
, Value must match regular expression ^[0-9]{1,34}$
Счет бенефициара
Возможные значения: <= 255 characters
Адрес бенефициара
Возможные значения: Value must match regular expression ^[0-9]{1,35}$
Корреспондентский счет банка бенефициара
Возможные значения: <= 255 characters
Адрес банка бенефициара
Возможные значения: <= 70 characters
Наименование филиала банка бенефициара
beneficiaryBankClearingCode
object
Клиринговый код банка бенефициара
Возможные значения: <= 11 characters
Клиринговый код банка-посредника
Возможные значения: Value must match regular expression ^[A-Z]{2}$
Обозначение национального клирингового кода банка-посредника
Возможные значения: <= 140 characters
Сокращенное наименование национального клирингового кода банка-посредника
Возможные значения: Value must match regular expression ^[A-Z]{2}$
Обозначение национального клирингового кода банка-посредника
Возможные значения: Value must match regular expression ^[0-9]{3}$
Цифровой код страны банка бенефициара
Возможные значения: Value must match regular expression ^[A-Z]{2}$
2х буквенный ISO-код страны банка бенефициара
Возможные значения: <= 140 characters
Наименование банка бенефициара
Возможные значения: <= 255 characters
Местонахождение банка бенефициара
Возможные значения: <= 11 characters
SWIFT-код банка бенефициара
Возможные значения: <= 11 characters
BEI-код (SWIFT-код)
Возможные значения: Value must match regular expression ^[0-9]{3}$
Цифровой код страны бенефициара
Возможные значения: Value must match regular expression ^[A-Z]{2}$
2х буквенный ISO-код страны бенефициара
Возможные значения: <= 255 characters
, Value must match regular expression ^[А-Яа-я]*$
Наименование страны бенефициара на русском языке (краткое наименование)
Возможные значения: Value must match regular expression ^([0-9]{10}|[0-9]{12}|0)$
ИНН бенефициара. 10 либо 12 цифр, либо 0
Возможные значения: <= 140 characters
Наименование бенефициара
Возможные значения: <= 35 characters
Город (месторасположение) бенефициара
Возможные значения: Value must match regular expression ^(BEN|SHA|OUR)$
Тип комиссии за перевод BEN, SHA или OUR
codes23e
object[]
Возможные значения: <= 4 characters
Код инструкции
Возможные значения: <= 255 characters
Возможные значения: <= 30 characters
Дополнительная информация
Дата документа
digestSignatures
object[]
Электронные подписи по дайджесту документа
Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
Возможные значения: non-empty
Значение электронной подписи, закодированное в Base64
Идентификатор документа в организации-партнере (UUID)
Фактический курс конверсии
Возможные значения: <= 255 characters
Адрес банка-посредника
Возможные значения: Value must match regular expression ^[0-9]{3}$
Цифровой код страны банка-посредника
Возможные значения: Value must match regular expression ^[A-Z]{2}$
2х буквенный ISO-код страны банка-посредника
Возможные значения: <= 140 characters
Наименование банка-посредника
Возможные значения: <= 35 characters
Местоположение банка-посредника
Возможные значения: <= 11 characters
SWIFT-код банка-посредника
iMediaClearingCode
object
Клиринговый код банка бенефициара
Возможные значения: <= 11 characters
Клиринговый код банка-посредника
Возможные значения: Value must match regular expression ^[A-Z]{2}$
Обозначение национального клирингового кода банка-посредника
Возможные значения: <= 140 characters
Сокращенное наименование национального клирингового кода банка-посредника
Возможные значения: Value must match regular expression ^[A-Z]{2}$
Обозначение национального клирингового кода банка-посредника
Возможные значения: <= 140 characters
Наименование филиала банка-посредника
Возможные значения: Value must match regular expression ^([0-9]{10}|[0-9]{12}|0)$
ИНН клиента
linkedDocs
object[]
Идентификатор документа в организации-партнере (UUID)
Возможные значения: non-empty
и <= 50 characters
Тип связанного документа
Возможные значения: Value must match regular expression ^[0-9]{1,7}$
Номер документа
Возможные значения: Value must match regular expression ^[KF]$
Опция "K" , "F" для поля 50а
Возможные значения: Value must match regular expression ^[AD]$
Опция "A", "D" для поля 56а
Возможные значения: Value must match regular expression ^[AD]$
Опция "A", "D" для поля 57а
Возможные значения: Value must match regular expression ^[AF]$
Опция "А", "F" для поля 59а или «без опции»
Возможные значения: <= 160 characters
Наименование организации клиента
Возможные значения: Value must match regular expression ^[0-9]{20}$
Счет перевододателя
Возможные значения: <= 120 characters
Адрес перевододателя
Возможные значения: Value must match regular expression ^[0-9]{9}$
БИК банка перевододателя
Возможные значения: <= 35 characters
Местонахождение банка перевододателя
Возможные значения: Value must match regular expression ^[0-9]{3}$
Цифровой код страны перевододателя
Возможные значения: Value must match regular expression ^[A-Z]{2}$
2х буквенный ISO-код страны перевододателя
Возможные значения: <= 80 characters
Наименование страны перевододателя на русском языке (краткое наименование)
Возможные значения: <= 140 characters
Международное наименование перевододателя
Возможные значения: <= 35 characters
Город (местонахождение) перевододателя
Возможные значения: <= 146 characters
Назначение платежа
Возможные значения: <= 10 characters
Направление платежа (Платеж внутри или вне СБРФ): 1-внутри, 0-вне
С курсом проведения конверсионной операции согласны
Срочность. Значение необходимо отправлять, если по счету списания есть возможность отправлять неотложные платежи.
Дата валютирования/возврата
Возможные значения: >= 0.01
Фактическая сумма списанной валюты
{
"bankStatus": "string",
"bankComment": "string",
"addInfo": "string",
"additionalInfo": "string",
"amountTransfer": {
"amount": "1.01",
"currencyCode": "string",
"currencyName": "string"
},
"authPersonName": "Петров Петр Иванович",
"authPersonTelfax": 79263689379,
"b77info": "string",
"beneficiaryAccount": "40802810600000200000",
"beneficiaryAddress": null,
"beneficiaryBankAccount": "40802810600000200000",
"beneficiaryBankAddress": "3, AVENUE HOCHE",
"beneficiaryBankBranchName": "TREASURY DEPARTMENT",
"beneficiaryBankClearingCode": {
"clearingCode": "BLAAAOUL",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"beneficiaryBankCountryDigital": "string",
"beneficiaryBankCountryIso2": "string",
"beneficiaryBankName": "ALANDSBANKEN ABP (FINLAND),SVENSK FILIAL",
"beneficiaryBankPlace": "string",
"beneficiaryBankSwift": "string",
"beneficiaryBeiCode": "string",
"beneficiaryCountryDigital": "643",
"beneficiaryCountryIso2": "string",
"beneficiaryCountryName": "string",
"beneficiaryInn": "string",
"beneficiaryName": "EMIRP",
"beneficiaryPlace": "MOSKVA",
"chargesType": "string",
"codes23e": [
{
"code": "string",
"description": "string",
"info": "string"
}
],
"date": "2023-12-31",
"digestSignatures": [
{
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w=="
}
],
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"factRate": "1.0001",
"iMediaBankAddress": "33 BEETHOVENSTRASSE",
"iMediaBankCountryDigital": "576",
"iMediaBankCountryIso2": "CH",
"iMediaBankName": "ABN AMRO BANK (SCHWEIZ)",
"iMediaBankPlace": "ZURICH",
"iMediaBankSwift": "ABNACHZZ80A",
"iMediaClearingCode": {
"clearingCode": "BLAAAOUL",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"iMediaFilialBankName": "FILIAL ONE OF ABN AMRO BANK (SCHWEIZ)",
"inn": "string",
"linkedDocs": [
{
"docExtId": "31663ef5-7975-4016-b0f3-f1d70a4e9c22",
"type": "string"
}
],
"number": "string",
"option50a": "K",
"option56a": "A",
"option57a": "A",
"option59a": "A",
"orgName": "string",
"payerAccount": "12341234123412341234",
"payerAddress": "UL.DOBROLIUBOVA,D.18,OF.III\t",
"payerBankBic": "044525225",
"payerBankPlace": "MOSCOW",
"payerCountryDigital": "643",
"payerCountryIso2": "RU",
"payerCountryName": "БЕЛАРУСЬ",
"payerName": "LLC COMPANY",
"payerPlace": "MOSCOW",
"paymentDetails": "CONTRACT 12321",
"paymentDirection": "0",
"rateAgree": true,
"urgent": true,
"valueDate": "2023-12-31",
"amountDebitTotal": "1.01"
}
"Ошибка в запросе"
Cause | Message | Description |
---|---|---|
DESERIALIZATION_FAULT | Неверный формат запроса | Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request запроса. Скорректируйте заполнение атрибутов и повторите запрос. |
VALIDATION_FAULT | Ошибка валидации | Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request запроса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
"Не авторизован"
Cause | Message | Description |
---|---|---|
UNAUTHORIZED | accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
"Операция не может быть выполнена: доступ к ресурсу запрещен"
Cause | Message | Description |
---|---|---|
ACTION_ACCESS_EXCEPTION | Операция не может быть выполнена: доступ к ресурсу запрещен | Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция PAY_DOC_RU . Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщ ение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
Данные не найдены
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}