DocumentaçãoReferência APIJourneyGitHub
Cadastro sandboxLogin sandboxen/us

2a. Classical Account On-boarding

In this topic, we separate all information related to Wirecard Accounts such as account creation/consultation and requesting permission to access users. In addition, in this section, you have all the necessary information to manage the transactions of users associated with your marketplace.

When a seller has a Classic Wirecard Account it means that they can log into the Wirecard Account and manage their sales in the Wirecard environment and dashboard. However, a marketplace can embark on the entire experience presented on the Wirecard Account in its environment, including bank transfers, balance inquiries, withdrawals, refunds, etc. according to OAuth permissions.

In this section (Classical Account On-boarding) you will have all information about creating/consulting a Wirecard Account , requesting permission from its users, and accessing account information.

Name

Description

Details

email

Account's e-mail.

structured

└─address

Account email address. It will be used as a login.

string,
mandatory

person

Personal data. If the registration is for a legal entity, the data must be from one of the partners or attorneys represent.

structured

├─name

Name.

string,
mandatory

├─lastName

Surname.

string,
mandatory

├─taxDocument

Identity document.

structured

├─├─type

Document type. Possible value: CPF.

string,
mandatory

├─└─number

Document number.

string,
mandatory

├─identityDocument

Identification document.

structured

├─├─type

Document type. Possible value: RG.

string

├─├─number

Document number.

string

├─├─issuer

Document issuer.

string

├─└─issueDate

Document issue date.
Format YYYY-MM-DD.

date

├─birthDate

Birhtdate.

date (YYYY-MM-DD) mandatory

├─nationality

Birth country. 3 letter abbreviation.

string

├─birthPlace

Birth city.

string

├─parentsName

Affiliation.

structured

├─├─mother

Mother name.

string

├─└─father

Father name.

string

├─phone

Phone.

structured

├─├─countryCode

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

string,
mandatory

├─├─areaCode

Phone DDD (local code).

string,
mandatory

├─└─number

Phone number.

string,
mandatory

├─alternativePhones

Alternative phone numbers.

structured list

├─├─countryCode

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

string

├─├─areaCode

Phone DDD (local code).

string

├─└─number

Phone number.

Phone number.

├─address

Address.

structured

├─├─street

Street name.

string,
mandatory

├─├─streetNumber

Number.

integer

├─├─complement

Complement.

string

├─├─district

District.

string,
mandatory

├─├─zipCode

Zipcode.

string,
mandatory

├─├─city

City.

string,
mandatory

├─├─state

State. 2 letter abbreviation.

string,
mandatory

└─└─country

Country. Format ISO-alpha3. Example BRA.

string,
mandatory

company

Company data. Used for business accounts only.

structured,
(business accounts only)

├─name

Company name.

string

├─businessName

Corporate name.

string

├─taxDocument

Company identity document.

structured

├─├─type

Document type. Possible value: CNPJ.

string

├─└─number

Document number.

string

├─mainActivity

Main activity branch.

structured

├─├─cnae

CNAE activity code. Example 82.91-1/00.

string

├─└─description

Activity description. Example: Collection activities and registration information.

string

├─openingDate

Opening date. Format YYYY-MM-DD.

date

├─phone

Company phone.

structured

├─├─countryCode

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

string

├─├─areaCode

Phone DDD (local code).

string

├─└─number

Phone number.

string

├─address

Address.

structured

├─├─street

Street name.

string

├─├─streetNumber

Number.

string

├─├─complement

Complement.

string

├─├─district

District.

string

├─├─zipCode

Zipcode.

string

├─├─city

City.

string

├─├─state

State. 2 letter abbreviation.

string

└─└─country

Country. Format ISO-alpha3. Example BRA.

string

businessSegment

Business category.

structured

└─id

Category identifier, according to the list of categories. See the [Business Categories] table (# establishment-categories) for possible values.

string

site

Website address.

string

type

Account type. Possible values: CONSUMER, MERCHANT. Platforms and Marketplaces must use the MERCHANT value to create accounts for their users.

string,
mandatory

tosAcceptance

Use terms acceptance data.

structured

├─acceptedAt

Use terms acceptance date.

datetime

├─ip

User IP address when accepting the terms of use.

string

└─userAgent

The userAgent used by the user when accepting the use terms.

string