Запрос сведений о клиенте

В настоящем документе при описании параметров запросов и ответов используются следующие обозначения типов данных:

string – строка;
array - массив данных;
object - объект данных;
data - дата;
boolean - булевый (логический) тип данных;
int. (integer) - целочисленный тип данных;
amount - числовой тип данных (сумма).

Список параметров запроса:

Параметр	Тип	Описание	Пример заполнения
`responseType`	string	Тип запрашиваемой информации. Возможные значение: `contacts` - контактная информация (в ответ добавится блок `contacts`); `contactsExtra` - дополнительная контактная информация (в ответ добавится блок `contactsExtra`); `bindings` - связки (в ответ добавится блок `bindings`); `permissions` - разрешения (в ответ добавится блок `permissions`).	`contacts,contactsExtra,bindings,permissions`

Формат запроса:

POST /api/clients/ HTTP/1.1

Host: 3dsec.sberbank.ru/sbersafe

Authorization: <accessToken>

Content-Type: application/json

Accept: application/json; version=1.0

Content-Length: <content-lenght>

{

  "responseType":"<responseType>"

}

Параметры ответа:

Параметр	Тип	Описание	Пример заполнения
`client`	object	Массив клиентской информации
`uuid`	string	Идентификатор клиента, длина 32.	`C2BC84C12AD6438DAA0D87517C7AE187`
`createdDate`	date	Дата создания клиента.	`07.09.2017 17:43:57.768`
`contacts`	array	Массив клиентских данных
`contactStatus`	string	Статус контактного средства. Возможные значения: `ACTIVE` - контактное средство активно; `NOTACTIVE` - контактное средство неактивно.	`ACTIVE`
`type`	string	Тип передаваемого контактного средства. Возможны следующие значения: `MPHONE` - мобильный телефон; `EMAIL` - электронная почта.	`EMAIL`
`value`	string	Маскированное значение контактного средства.	en@test.ru
`contactsExtra`	array	Массив клиентских данных.
`contactStatus`	string	Статус контактного средства. Возможные значения: `ACTIVE` - контактное средство активно; `NOTACTIVE` - контактное средство неактивно.	`ACTIVE`
`type`	string	Тип передаваемого контактного средства. Возможные значения: `POST_ADRESS` - почтовый адрес.	`POST_ADRESS`
`value`	string	Маскированное значение контактного средства.	`109028, Москва, ул. Земляной Вал, 50А/8 стр.2`
`bindings`	array	Массив данных о связках клиента.
`uuid`	string	Идентификатор связки.	`87414E0F13AB4542AA9D10E81F74A6E3`
`createdDate`	date	Дата создания связки.	`07.09.2017 17:43:57.796`
`mnemonic`	string	Название карты, заданное клиентом.	`my second best card`
`paymentType`	string	Тип платёжного средства.	`CARD`
`paymentSystem`	string	Тип платёжной системы.	`VISA`
`card`	object	Объект карточных данных.
`maskedPan`	string	Маскированный номер карты.	`5111111199`
`extendedInfo`	string	Указание на наличие возможности получения расширенной информации по связке/карте.	`true`
`permissions`	object	Объект специальных разрешений.
`cardVirtual`	boolean	Указание на возможность создания виртуальной карты.	`true`
`requestId`	string	{section>integration:api:params:requestId#General&noheader}}	`gbhjnkme-rdcfgv-hbjnkm-7689ui-okp3ew`
`status`	string	Указание на статус результата обработки запроса	`SUCCESS`

В случае если клиент не найден - объект client в объекте отсутствует.

Формат ответа:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-lenght>
Cache-Control: no-store
 
{
  "client": 
	{
        "uuid": "<clientUuid>", 
        "createdDate": "<createdDate>"
    },
  "contacts": [
      {
        "contactStatus": "<contactStatus>",
        "type": "<type>",
        "value": "<value>"
      },
      {
        "contactStatus": "<contactStatus>",
        "type": "<type>",
        "value": "<value>"
      }
    ],
  "contactsExtra": [
      {
        "contactStatus": "<contactStatus>",
        "type": "<type>",
        "value": "<value>"
      },
      {
        "contactStatus": "<contactStatus>",
        "type": "<type>",
        "value": "<value>"
      }
    ],
  "bindings": [
      {
        "uuid": "<uuid>",
        "createdDate": "<createdDate>",
        "mnemonic": "<mnemonic>",
        "paymentType": "<paymentType>",
        "paymentSystem": "<paymentSystem>",
        "card": {
            "maskedPan": "<maskedPan>"
          }
        "extendedInfo": <true|false>
      },
      {
        "uuid": "<uuid>",
        "createdDate": "<createdDate>",
        "mnemonic": "<mnemonic>",
        "paymentType": "<paymentType>",
        "paymentSystem": "<paymentSystem>",
        "card": {
            "maskedPan": "<maskedPan>"
          }
        "extendedInfo": <true|false>
      }
    ],
  "permissions":{
        "cardVirtual": <true|false>
    },
  "requestId": "<requestId>",
  "status": "<status>"
}

Инструменты страницы

Запрос сведений о клиенте