3. Customers

The customer is the service user or the buyer of your online store. This API allows the registration, consultation of a particular client, and the listing of all registered customers.

Request attributes

Name

Description

Details

ownId

Customer unique id.

String (65),
mandatory
Required for the Protected Sale program.

fullname

Customer full name.

String (90),
mandatory
Required for the Protected Sale program.

email

Customer Email.

String (45),
mandatory
Required for the Protected Sale program.

phone

Customer phone.

Object,
mandatory
Required for the Protected Sale program.

├─countryCode

Phone DDI (International code). Possible value: 55.

Integer (2),
mandatory
Required for the Protected Sale program.

├─areaCode

Phone DDD (Local code).

Integer (2),
mandatory
Required for the Protected Sale program.

└─number

Phone number.

Integer (16),
mandatory
Required for the Protected Sale program.

birthDate

Customer birthdate.

Date (YYYY-MM-DD),

mandatory
Required for the Protected Sale program.

taxDocument

Identity document

Object,

mandatory
Required for the Protected Sale program.

├─type

Document type. Possible values: CPF or CNPJ.

String,
mandatory
Required for the Protected Sale program.

└─number

Document number.

String (CPF:11 and CNPJ:14),
mandatory
Required for the Protected Sale program.

shippingAddress

Customer shipping address

Object,
mandatory
Required for the Protected Sale program.

├─street

Street name.

string(140),
mandatory
Required for the Protected Sale program.

├─streetNumber

Number.

string(10),
mandatory
Required for the Protected Sale program.

├─complement

Complement.

string(140)

├─district

District.

String,
mandatory
Required for the Protected Sale program.

├─city

City.

String,
mandatory
Required for the Protected Sale program.

├─state

State. 2 letter abbreviation.

String (2),
mandatory
Required for the Protected Sale program.

├─country

Birth country. 3 letter abbreviation. Example: BRA.

String (3),
mandatory
Required for the Protected Sale program.

└─zipCode

Zipcode.

String (20),
mandatory
Required for the Protected Sale program.

fundingInstruments

Funding instruments.

Structured list

├─method

Funding instruments structure. Possible values:
CREDIT_CARD.

String

├─creditCard

Credit card structure.

Object

├ ├─hash

Encrypted credit card data.

String

├ ├─number

Credit card number. (You must be within the PCI scope to send this field without encryption).

String (18)

├ ├─expirationMonth

Credit card expiration month. (You must be within the PCI scope to send this field without encryption).

Integer (2)

├ ├─expirationYear

Credit card expiration year.
(You must be within the PCI scope to send this field without encryption).

Integer (4)

├ ├─cvc

Credit card CVC.
(You must be within the PCI scope to send this field without encryption).

Integer

├ ├─id

Credit card unique code (Generated by Wirecard).

string(16),
response

├ ├─brand

Credit card brand. Possible values: VISA, MASTERCARD, AMEX, DINERS, ELO, HIPER, HIPERCARD.

String,
response

├ ├─first6

Credit card first six digits.

Integer,
response

├ ├─last4

Credit card last four digits.

Integer,
response

├ ├─holder

Credit card holder.

Structured

├ ├ ├─store

Determines when creating a payment whether the credit card used should be saved to 1Click2Buy (default: true). Possible values: true or false.

Boolean

├ ├ ├─fullname

Credit card holder name.

String (65)

├ ├ └─birthDate

Credit card holder birthdate.

Date (YYYY-MM-DD)

├ ├─phone

Credit card holder phone

Structured

├ ├ ├─countryCode

Phone DDI (International code). Possible value: 55.

Integer (2)

├ ├ ├─areaCode

Phone DDD (Local code).

Integer (2)

├ ├ └─number

Phone number.

Integer (16)

├ ├─taxDocument

Identity document.

Structured

├ ├ ├─type

Document type. Possible values: CPF or CNPJ.

String (4)

├ ├ └─number

Document number.

String (CPF:11 and CNPJ:14)

└ └─billingAddress

Billing address.

Object

     ├─street

Street name.

String

     ├─streetNumber

Number.

String

     ├─complement

Complement.

String

     ├─district

District.

String

     ├─city

City.

String

     ├─state

State. 2 letter abbreviation.

String (2)

     ├─country

Country. 3 letter abbreviation. Example: BRA.

String (3)

     └─zipCode

Zipcode.

String (20)

Callback Attributes

Name

Description

Type

creditCard

Credit card.

Object

├─id

Credit card unique code (Generated by Wirecard).

String (16)

├─brand

Credit card brand. Possible values: VISA, MASTERCARD, AMEX, DINERS, ELO, HIPER, HIPERCARD.

String

├─first6

Credit card first six digits.

Integer

├─last4

Credit card last four digits.

integer