billingDetails object

billingDetails has the following attributes:

Table 1. billingDetails object
billingDetails
Attribute Required Format
reference

Buyer reference.

string n..80
title

Buyer's title.

Examples of possible values: Mr, Ms, etc.

  string n..80
type

Buyer type.

The possible values are:

  • PRIVATE for a private client.
  • COMPANY for a company.
  string (enum)
firstName

Buyer's last name.

  string ans..128
lastName

Buyer's first name.

  string ans..128
phoneNumber

Buyer's phone number.

  string ans..32
email

Buyer's e-mail.

Mandatory parameter required for creating a token.

for creating a token

string ans..150
streetNumber

Buyer's street number.

Note: if this attribute is present in the query, it cannot be submitted empty.

  string an..5
address

Buyer's address.

  string ans..255
district

Buyer's district.

  string ans..127
zipCode

Buyer's postal code.

  string ans..64
city

Buyer's city.

  string ans..128
state

Buyer's State/Region.

  string ans..128
country

Buyer's country according to the ISO 3166 standard.

Examples of the possible values:
  • DE for Germany
  • IT for Italy
  • PT for Portugal
  • GB for the UK
  • JA for Japan
  • RU for Russia
  • ES for Spain
  • NL for the Netherlands
  • SE for Sweden
  • FR for France
  • PL for Poland
  • CN for China
  string - a2
language

Buyer's language according to the ISO 639-1 standard.

Examples of the possible values:
  • de for German
  • it for Italian
  • pt for Portuguese
  • en for English
  • ja for Japanese
  • ru for Russian
  • es for Spanish
  • nl for Dutch
  • sv for Swedish
  • fr for French
  • pl for Polish
  • zh for Chinese
  • tr for Turkish
   
  string - a2
cellPhoneNumber

Cell phone number

  string ans..32
identityCode

Allows each citizen to identify him/herself with a unique ID within a country.

For example, in Brazil, ClearSale requires this field to be populated with the CPF/ CPNJ (in numeric format, between 11 and 20 digits long).

  string ans..255