Получение информации о совершенных переводах

Обновлено 7 февраля 2025

POST

/v2/corporate-cards/transfer/list

Возвращает cписок документов «Заявление на перевод с бизнес-карты» по токену авторизации пользователя, а также статусы переводов по этим заявлениям за указанный период.

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

Запрос

• application/json

Body

required

startDate

date

Дата начала периода, за который нужна выписка по переводам

endDate

date

Дата окончания периода, за который нужна выписка по переводам

withDrafts

boolean

Признак вывода черновиков (true - все переводы, false - только прошедшие исполнение)

pagination objectrequired

Объект запроса при для получении постраничного списка моделей

offset

int32

required

Сдвиг элементов

count

int32

required

Возможные значения: >= 1 и <= 10000

Количество записей на странице

Ответы

• 200
• 400
• 403
• 500

Успешный ответ

• application/json

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

Schema

transfers object[]
Possible values: <= 999
Список переводов
Array [
externalId
string
required
Возможные значения: <= 255 characters
Идентификатор документа, присвоенный сервисом (UUID)
transferPurpose
string
required
Возможные значения: <= 254 characters
Назначение перевода
transferAmount objectrequired
Данные о сумме и валюте
amount
number
required
Сумма перевода
currency
string
required
Возможные значения: [RUR]
transferCommission objectrequired
Данные о сумме и валюте
amount
number
Сумма (перевода, платежа и т.д.)
currency
string
Возможные значения: [RUR]
senderInfo objectrequired
Информация об отправителе
maskedCardNumber
string
Возможные значения: <= 255 characters
Замаскированный номер карты
receiverInfo objectrequired
Информация о переводе
maskedCardNumber
string
Возможные значения: <= 255 characters
Замаскированный номер карты
phoneNumber
string
Возможные значения: Value must match regular expression ^(79)\d{9}$
Номер телефона
lastName
string
Возможные значения: <= 255 characters
Фамилия
firstName
string
Возможные значения: <= 255 characters
Имя
middleName
string
Возможные значения: <= 255 characters
Отчество
bankName
string
Возможные значения: <= 255 characters
Банк получателя
organizationName
string
Возможные значения: <= 1024 characters
Наименование организации получателя
createDate
date-time
required
Дата и время создания документа
status
string
required
Возможные значения: [FORM, ERROR, PROCESSING, END]
statusDescription
string
required
Возможные значения: [Заявка создана, требуется подтверждение, Сформируйте новую заявку на перевод, Запросите статус заявки позднее, Заявка успешно исполнена]
]
pagination objectrequired

Объект ответа при для получении постраничного списка моделей

hasNextPage

boolean

required

Признак наличия следующей страницы

offset

int32

required

Сдвиг элементов

count

int32

required

Возможные значения: >= 1 и <= 10000

Количество записей на странице

{
  "transfers": [
    {
      "externalId": "9b9f1b57-425e-4aff-9856-21fc4951f1e8",
      "transferPurpose": "string",
      "transferAmount": {
        "amount": 1000.22,
        "currency": "RUR"
      },
      "transferCommission": {
        "amount": 1000.22,
        "currency": "RUR"
      },
      "senderInfo": {
        "maskedCardNumber": "220220******0760"
      },
      "receiverInfo": {
        "maskedCardNumber": "220220******0760",
        "phoneNumber": "79268889767",
        "lastName": "string",
        "firstName": "string",
        "middleName": "string",
        "bankName": "СБЕРБАНК",
        "organizationName": "ПАО ВСПЫШКА"
      },
      "createDate": "2024-07-29T15:51:28.071Z",
      "status": "FORM",
      "statusDescription": "Заявка создана, требуется подтверждение"
    }
  ],
  "pagination": {
    "hasNextPage": true,
    "offset": 0,
    "count": 0
  }
}

Ошибка бизнес-логики

• application/json

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

Schema

errorCode

string

required

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

Код ошибки

errorType

string

required

Возможные значения: [VALIDATION_ERROR, UNEXPECTED_SOWA_ERROR, CONTEXT_ERROR, GATEWAY_ERROR, UNEXPECTED_SERVER_ERROR, FORBIDDEN_ERROR, INTEGRATION_ERROR, BUSINESS_LOGIC_ERROR, REQUEST_LIMIT_EXCEED]

errorDesc

string

required

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

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

requestId

string

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

Уникальный идентификатор запроса

{
  "errorCode": "string",
  "errorType": "VALIDATION_ERROR",
  "errorDesc": "string",
  "requestId": "string"
}

Нет доступа к услуге / сервису

• application/json

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

Schema

errorCode

string

required

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

Код ошибки

errorType

string

required

Возможные значения: [VALIDATION_ERROR, UNEXPECTED_SOWA_ERROR, CONTEXT_ERROR, GATEWAY_ERROR, UNEXPECTED_SERVER_ERROR, FORBIDDEN_ERROR, INTEGRATION_ERROR, BUSINESS_LOGIC_ERROR, REQUEST_LIMIT_EXCEED]

errorDesc

string

required

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

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

requestId

string

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

Уникальный идентификатор запроса

{
  "errorCode": "string",
  "errorType": "VALIDATION_ERROR",
  "errorDesc": "string",
  "requestId": "string"
}

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

• application/json

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

Schema

errorCode

string

required

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

Код ошибки

errorType

string

required

Возможные значения: [VALIDATION_ERROR, UNEXPECTED_SOWA_ERROR, CONTEXT_ERROR, GATEWAY_ERROR, UNEXPECTED_SERVER_ERROR, FORBIDDEN_ERROR, INTEGRATION_ERROR, BUSINESS_LOGIC_ERROR, REQUEST_LIMIT_EXCEED]

errorDesc

string

required

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

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

requestId

string

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

Уникальный идентификатор запроса

{
  "errorCode": "string",
  "errorType": "VALIDATION_ERROR",
  "errorDesc": "string",
  "requestId": "string"
}

Loading...

Loading...