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



Request to search for a 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:

Either one of «phone» and «email» must be specified.

Parameter Type Description Value example

merchantLogin

string

The partner identifier you received when registering in the payment gateway.

our_best_merchant

phone

string

Customer's phone number without a leading «7».

9171131231

email

string

Customer's email address.

test@test.ru

Request format: 

POST /api/clients/find HTTP/1.1
Host: 3dsec.sberbank.ru/sbersafe
Content-Type: application/json
Accept: application/json; version=1.0
Content-Length: <content-lenght>

{
  "phone": "<phone>",
  "email": "<email>"
}

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

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": "<uuid>",
    "createdDate": "<createdDate>"
  },
  "requestId":"<requestId>",
  "status": "<status>"
}