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

Содержание



Request for the information about the customer

In this document, the following data type conventions are used when describing request and response parameters:

  • string – string;
  • array – data array;
  • object – data object;
  • data – date;
  • boolean – boolean (logical) data type;
  • int. (integer) – integer data type;
  • amount – a numeric data type (amount).

List of the request parameters:

Parameter Type Description Value example

responseType

string

Type of information requested. Possible value:

  • contacts – contact information (the contacts block will be added to the response);
  • contactsExtra – additional contact information (the contactsExtra block will be added to the response);
  • bindings – bindings (bindings block will be added to the response);
  • permissions - permissions (permissions block will be added to the response).
 contacts,contactsExtra,bindings,permissions

Request format: 

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>"

}

Response parameters:

Parameter Type Description Value example

client

object

Array of customer information

uuid

string

Customer identifier, length 32.

C2BC84C12AD6438DAA0D87517C7AE187

createdDate

date

Date of the customer creation.

07.09.2017 17:43:57.768

contacts

array

Array of customer data

contactStatus

string

Status of the contact mean. The possible values are:

  • ACTIVE – contact is active;
  • NOTACTIVE – contact is inactive.
 ACTIVE

type

Name

type

Type

string

Description

General

Type of contact mean to be transferred. The following values are available:

  • MPHONE – mobile phone;
  • EMAIL – email.

sbersafe

Specifying the entity type, the following values are possible:

  • client – customer;
  • binding – binding.

Type of contact mean to be transferred. The following values are available:

  • MPHONE – mobile phone;
  • EMAIL – email.
 EMAIL
value string Masked value of the contact mean. en@test.ru
contactsExtra array Array of customer data.

contactStatus

string

Status of the contact mean. The possible values are:

  • ACTIVE – contact is active;
  • NOTACTIVE – contact is inactive.
 ACTIVE
type string

Type of contact mean to be transferred. The possible values are:
POST_ADRESS – postal address.

POST_ADRESS
value string Masked value of the contact mean. Bld. 2, 50A/8 Zemlyanoy Val St., Moscow, Russia, 109028
bindings array Array of data about the customer's bindings.
uuid string Binding identifier. 87414E0F13AB4542AA9D10E81F74A6E3
createdDate date Date of the binding creation. 07.09.2017 17:43:57.796
mnemonic string Card name specified by the customer. my second best card
paymentType string Type of payment means. CARD
paymentSystem string Payment system type. VISA
card object Card data object.
maskedPan string Masked card number. 5111111199
extendedInfo string Indication of the availability of extended binding/card information receiving. true
permissions object Special permissions object.
cardVirtual boolean Indication whether a virtual card can be created. true

requestId

string

{section>integration:api:params:requestId#General&noheader}} gbhjnkme-rdcfgv-hbjnkm-7689ui-okp3ew

status

string

Indication of the status of the request processing result

SUCCESS

If the customer is not found, the client object is missing in the object.

Response format: 

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>"
}