Актуальный поиск также поддерживает список
subMerchantIdsи фильтрsubMerchantType;pageпо умолчанию0,size—10.
URL
Информация о http методе и endpoint для поиска субмерчанта приведена ниже:
| HTTP Method | URL | URL Parametrləri |
|---|---|---|
GET |
/onboarding/v1/sub-merchants |
Для параметров URL смотрите Параметры поиска сабмерчанта |
Параметры запроса
Ожидаемые параметры, которые будут отправлены в запросах для поиска существующего субмерчанта, перечислены ниже в таблице и подзаголовках.
| Название параметра | Тип | Обязательный | Объяснение |
|---|---|---|---|
name |
string |
Да | Имя субмерчанта |
address |
string |
Да | Адрес субмерчанта |
email |
string |
Да | Электронный адрес субмерчанта |
iban |
string |
Да | IBAN субмерчанта |
gsmNumber |
string |
Да | gsm номер субмерчанта |
taxOffice |
string |
Да | Налоговое учреждение субмерчанта |
taxNumber |
string |
Да | Налоговый номер субмерчанта |
contactName |
string |
Да | Имя контактного лица субмерчанта |
contactSurname |
string |
Да | Фамилия контактного лица субмерчанта |
identityNumber |
string |
Да | Идентификационный номер субмерчанта |
legalCompanyTitle |
string |
Да | Официальное названии компании |
Параметры возврата
Параметры, возвращаемые в результате поиска субмерчанта, подчиняются правилам Форматы возврата на главной странице API документации. При отсутствии систематичной или структурной ошибки, нижние параметры возвращающегося объекта в data параметрах следующие:
| Название параметра | Тип | Всегда доступен | Объяснение |
|---|---|---|---|
id |
long |
Да | Значение идентификатора субмерчанта |
status |
Status |
Да | Значение, показывающее статус субмерчанта см. : Статус |
name |
string |
Да | Имя субмерчанта |
email |
string |
Да | Электронный адрес субмерчанта |
iban |
string |
Да | IBAN субмерчанта |
address |
string |
Да | Адрес субмерчанта |
gsmNumber |
string |
Да | gsm номер субмерчанта |
taxOffice |
string |
Да | Налоговое учреждение субмерчанта |
taxNumber |
string |
Да | Налоговый номер субмерчанта |
contactName |
string |
Да | Имя контактного лица субмерчанта |
contactSurname |
string |
Да | Фамилия контактного лица субмерчанта |
identityNumber |
string |
Да | Идентификационный номер |
legalCompanyTitle |
string |
Да | Официальное название компании |
subMerchantExternalId |
string |
Да | External ID субмерчанта |
subMerchantType |
SubMerchantType |
Да | Тип субмерчанта см. : Типы субмерчанта |
Примеры кодов
Вы можете просмотреть примеры кодов в Odero API client с открытым исходным кодом
- .NET: https://github.com/TokenPayEng/tokenpay-dotnet-client/blob/master/Samples/OnboardingSample.cs
- PHP: https://github.com/TokenPayEng/tokenpay-php-client/blob/master/samples/search_sub_merchants.php
- Java: https://github.com/TokenPayEng/tokenpay-java-client/blob/master/src/test/java/tr/com/tokenpay/sample/OnboardingSample.java
- Node.js: https://github.com/TokenPayEng/tokenpay-node-client/blob/master/samples/onboarding/SearchSubMerchants.js