Создать виртуальную карту
#
POST /buyers/createCardPOST /buyers/createCard
#
ОписаниеМетод createCard предназначен для создания виртуальной карты. Если клиента не существует в БД, то создается еще и сам клиент
#
ПараметрыТип | Имя | Описание | Схема |
---|---|---|---|
Query | apiKey обязательно | Апи ключ | string |
Query | brand необязательно | Внутренний код торговой марки. Если не указано, то создается мультибрендовая карта | string |
Query | phone обязательно | Номер телефона клиента | string |
Query | retailer обязательно | Внутренний код торговой сети | string |
#
ОтветыHTTP код | Описание | Схема |
---|---|---|
200 | successful operation | BuyerJSON |
801 | Неизвестный код торговой сети | Без содержимого |
839 | Неизвестный код торговой марки | Без содержимого |
840 | Номер телефона не может быть пустым | Без содержимого |
#
Возвращаетapplication/json
#
BuyerJSONИмя | Описание | Схема |
---|---|---|
phone обязательно | Номер телефона клиента | string |
additionalEmails необязательно | Дополнительные e-mail адреса | < string > array |
birthday необязательно | Дата рождения | string (date-time) |
cards необязательно | Список карт клиента | < CardJSON > array |
email необязательно | Адрес электронной почты | string |
emailVerified необязательно | Признак подтверждения email | string (date-time) |
gender необязательно | Пол клиента | enum (Male, Female) |
isBirthdaySuspended необязательно | Признак, что дата рождения не подтверждена | boolean |
name необязательно | ФИО клиента | string |
status необязательно | Статус клиента | enum (Active, Close, BlockedByCheat) |
verified необязательно | Признак подтверждения номера телефона | string (date-time) |
#
CardJSONИмя | Описание | Схема |
---|---|---|
cardDate обязательно | Дата создания карты | string (date-time) |
cardType обязательно | Тип карты | CardTypeJSON |
firstDateCheck необязательно | Дата первого чека по карте | string (date-time) |
number обязательно | Номер карты | string |
status обязательно | Статус карты Active(Активная), Disabled(Заблокированная), NonEmitted(Не выпущена), Temporary(Временная) | enum (Active, Disabled, NonEmitted, Temporary) |
type обязательно | Тип карты Material(Физическая), Virtual(Виртуальная) | enum (Material, Virtual) |
#
CardTypeJSONИмя | Описание | Схема |
---|---|---|
barcodeType обязательно | Формат штрих-кода карт | enum (EAN13, CODE128) |
internalCode обязательно | Внутренний код типа карты | string |
name обязательно | Наименование типа карты | string |