Сервис регистрации или закрытия мерчанта в рамках Service Request
/tom-bpm/api/v1/public/service-requests/{srType}
https://tacq-tom.tcsbank.ru/tom-bpm/api/v1/public/tom-bpm/api/v1/public/service-requests/{srType}
Метод предназначен для регистрации/закрытия мерчанта в рамках заявки на обслуживание.
Запрос
Header parameters
Required
authorization
String
authorization
Required
date
String
date
Path parameters
Required
srType
String
srType
Request body schema application/json
comment
String
Required
company
Object (TomServiceRequestCompanyDto)
Required
company
Object (TomServiceRequestCompanyDto)
Required
extCompanyId
String
Идентификатор компании в рамках учета Система Партнера (внешний по отношению к Банку)
Required
merchants
Array of objects ()
Required
merchants
Array of objects ()
address
Object (TomAddressDto)
address
Object (TomAddressDto)
apartment
String
Requirements: <= 20 characters
Номер квартиры/офиса
block
String
Requirements: <= 20 characters
Номер корпуса
building
String
Requirements: <= 20 characters
Номер строения
city
String
Requirements: <= 50 characters
Наименование города. Условно-обязателен к заполнению (если settlement пуст).
Required
country
String
Requirements: >= 3 characters and <= 3 characters, Value must match regular expression ^\d{3}$
Трехсимвольный цифровой код государства по ISO 3166-1. Например, код для государства Российская Федерация - 643
district
String
Requirements: <= 50 characters
Район с типом/префиксом
fiasId
String
Requirements: <= 50 characters
Идентификатор адреса по ФИАС
house
String
Requirements: <= 20 characters
Номер дома
kladrId
String
Requirements: <= 50 characters
Код адреса по КЛАДР
Required
postalCode
String
Requirements: non-empty and <= 6 characters
Почтовый индекс
Required
region
String
Requirements: non-empty and <= 50 characters
Регион с типом/префиксом
Required
result
String
Requirements: non-empty and <= 300 characters
Результирующий адрес одной строкой
settlement
String
Requirements: <= 100 characters
Регион с типом/префиксом, условно-обязателен к заполнению(если city пуст)
street
String
Requirements: <= 150 characters
Улица с типом/префиксом
Required
type
String
Requirements: [FACTUAL, JURIDICAL, REGISTRATION]
Тип адреса. FACTUAL - фактический адрес расположения объекта (торговой точки). JURIDICAL - юридический адрес регистрации объекта (компании). REGISTRATION - адрес регистрации субъекта (персоны - ЕИО, связанного контакта компании).
bankAccount
Object (TomBankAccountDto)
bankAccount
Object (TomBankAccountDto)
Required
bankName
String
Requirements: <= 100 characters
Наименование банка
Required
bic
String
Requirements: Value must match regular expression \d{9}
БИК Банка (Банковский идентификационный код)
corrAccount
String
Requirements: Value must match regular expression ^\d{20}$
Номер корреспонденсткого счета Банка
Required
currentAccount
String
Requirements: Value must match regular expression ^\d{20}$
Номер расчетного счета Получателя в Банке
kpp
String
Requirements: Value must match regular expression \d{9}
КПП Банка (Код причины постановки Банка, как организации, на учет в ФНС РФ)
buildType
String
Requirements: [BEAUTY_SALON, CAR_SERVICE, CATERING_POINT, DELIVERY_POINT, DWELLING, HOTEL, MEDICAL_CENTER, OFFICE, OTHER, PRODUCTION_FACILITY, SHOP, SPORT_CENTER, WAREHOUSE]
Тип помещения торговой точки
documents
Array of objects ()
documents
Array of objects ()
departmentCode
String
Requirements: <= 10 characters, Value must match regular expression \d{3}-\d{3}
Код подразделения. Заполняется для типа документа ПАСПОРТ.
Required
exemplars
Array of objects ()
Required
exemplars
Array of objects ()
comment
String
Requirements: <= 1500 characters
Комментарий к экземпляру документа
s3DetailInfo
Object (TomS3DetailInfo)
s3DetailInfo
Object (TomS3DetailInfo)
Required
bucketName
String
Название корзины в S3
Required
objectFormat
String
Requirements: [GIF, JPEG, JPG, PDF, PNG, TIF, TIFF]
Расширение файла
Required
objectKey
String
Ключ файла-документа в S3
Required
typeId
String
Requirements: [ALL_PAGES, CEO_OFFICE_TERM, EDS, ELECTRONIC_DOCUMENT, ELECTRONIC_WITH_EDS, FIRST_PAGE, MAIN_SPREAD_AND_REGISTRATION, MAIN_SPREAD_PAGE, ORIGINAL, OTHER, PASSPORT_HISTORY_SPREAD, PHOTO, REGISTRATION_PAGE, SECOND_PAGE, TAX_STAMP, TITLE_PAGE]
Тип экземпляра документа согласно справочнику
issueDate
String<date>
Дата выдачи документа
issuerInstitute
String
Requirements: <= 250 characters
Наименование органа, выдавшего документ
number
String
Requirements: <= 50 characters
Серия и номер паспорта (без разделителей)
Required
typeId
String
Requirements: [ACCOUNT_PROFILE_DATA, ACT_CONFIRMATION_STRUCTURE_KOU, AGGREGATOR_JOINING_APPLICATION, ANOTHER_BANK_ACCOUNT_STATEMENT, APPOINTMENT_NOTARY, ARBITRATION_CERTIFICATE, BO_ACCEPT, BUSINESS_MODEL, CHECKS, CLOSE_APPLICATION, CONFIRMATION_HMB_COMPOSITION, CUSTOMER_PHOTO, DOCUMENT_FOR_STAY_IN_RF, EGRUL_CHANGE_LIST, EGRUL_STATEMENT, FINANCIAL_STATEMENTS, FOREIGN_PASSPORT, FOREIGN_PUBLIC_OFFICIAL_CERTIFICATE, FOUNDERS_DECISION_PROTOCOL, FULL_PD_BO, GUARANTEE_LETTER, INFORMATION, INN, JOB_ORDER, JOINING_APPLICATION, LAWYER_CERTIFICATE, LEASE_CONTRACT, LICENSE, LOCATION_CONFIRMATION, MARRIAGE_CERTIFICATE, MIGRATION_CARD_VISA, NOTICE_OF_ESTABLISHMENT_LAWYER_OFFICE, OFFICE, OGRN, OTHER, PASSPORT, PASSPORT_VALIDITY_CERTIFICATE, POWER_OF_ATTORNEY_SIGNING, SHAREHOLDERS_EXCERPT, SNILS, TAX_RETURN, TEMPORARY_REGISTRATION, USTAV, USTAV_CHANGE_LIST]
Тип документа согласно справочнику
String
Requirements: Value must match regular expression ^[0-9a-zA-Zа-яА-ЯёЁ+_.-]+@[0-9a-zA-Zа-яА-ЯёЁ.-]+.[0-9a-zA-Zа-яА-ЯёЁ]{2,}$
Электронный почтовый адрес торговой точки
Required
extShopId
String
Requirements: non-empty and <= 30 characters
Идентификатор торговой точки (внешний, в рамках системы учета Партнера)
fee
Object (TomFeeDto)
fee
Object (TomFeeDto)
Required
amount
Object (TomAmountDto)
Required
amount
Object (TomAmountDto)
Required
fixed
Number<double>
Размер комиссии (фиксированный) в валюте для схемы типа fix или hybrid
Required
percentage
Number<double>
Requirements: <= 99.99
Размер комиссии (в %) от суммы операции для схемы типа percentage или hybrid
currency
Integer<int32>
Requirements: >= 1 and <= 999
Валюта комиссии. Трехзначный код валюты согласно стандарту ISO 4217. Рубли - 643
groupId
String
Наименование группового условия по комиссии. Заполняется при использовании специальных групповых условий по комиссии.
Required
type
String
Requirements: [FIX, HYBRID, PERCENT]
Тип условия расчета комиссии
nameEng
String
Requirements: <= 20 characters, Value must match regular expression ^[A-Z-a-z0-9 !\"#\$%\&\'\(\)\*\+,\-\./:;<\[\\\]\^\_\'=>\?@\{\|\}~]+$
Наименование торговой точки на английском языке (транслитерированное)
nameRus
String
Requirements: <= 100 characters
Наименование торговой точки на русском языке (как на вывеске)
phone
String
Requirements: <= 50 characters
Номер телефона торговой точкой
Required
terminals
Array of objects ()
Required
terminals
Array of objects ()
accessibilityCode
String
Requirements: non-empty and <= 30 characters
Код адаптивного решения для людей с инвалидностью. В параметр может быть передано двузначное число, либо несколько двузначных чисел через разделитель ;, без пробелов.
deviceConfigType
String
Requirements: [CASHIER, CLIENT]
Тип конфигурации платежного устройства. CASHIER - ТСП кассир, CLIENT - ТСП клиент
deviceManufacturer
String
Requirements: <= 50 characters
Производитель устройства оплаты
deviceSoftware
String
Requirements: <= 50 characters
Название программного обеспечения устройства
Required
mcc
String
Requirements: <= 4 characters, Value must match regular expression ^\d{4}$
МСС (Merchant Category Code), соответствующий деятельности торговой точки
paymReaderManufacturer
String
Requirements: <= 50 characters
Производитель внешнего считывателя бесконтактных платежей. Если не заполнено - указать ОТСУТСТВУЕТ
paymReaderModel
String
Requirements: <= 50 characters
Модель внешнего считывателя бесконтактных платежей
Required
serialNumber
String
Requirements: non-empty and <= 50 characters
Серийный номер терминала
Required
type
String
Requirements: <= 50 characters, [RETAIL, VENDING]
Тип терминала. RETAIL - тип терминалов, используемый при торговле с участием продавца, VENDING - тип терминалов, используемый при торговле с устройства самообслуживания (вендингового аппарата)
paymentType
String
Requirements: [POS, MPOS, SOFTPOS]
Default: POS
Тип технологии оплаты. Традиционный тип POS (point-of-sale) - терминал, mPOS (mobile POS) - гибридный тип, использующий мобильное устройство и специальный приемник карт, SoftPOS (software POS) - программный тип технологии, использующий только мобильное устройство для приема платежа. Поле не обязательно к заполнению. Если значение не передано, по умолчанию устанавливается тип технологии оплаты - POS.
partnerId
Integer<int64>
Ответ
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
Это полезный материал?