2b. Transparent Account On-boarding

From a development perspective, the only difference between the data to create a Classic Account and a Transparent Account is the transparentAccount attribute.

If the Marketplace wants to offer Transparent Accounts to its sellers, this means that the entire settlement and withdrawal process must be shipped on the Marketplace or Platform (done via API). In the case of Transparent Accounts, sellers do not have access to the Wirecard Account with the entire control dashboard.

❗️

ATTENTION

The Marketplace has full responsibility for these accounts and for providing service to sellers. No direct contact between Marketplace or Platform vendors and Wirecard can be made in this case.

Name

Description

Details

transparentAccount

Attribute to create a transparent Wirecard account.

boolean,
mandatory

email

Account email.

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.

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

Birthdate.

date (YYYY-MM-DD) mandatory

├─nationality

Birth country. 3 letter abbreviation. Example: BRA.

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 phones.

structured list

├─├─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,
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

Birth country. 3 letter abbreviation. Example: BRA.

string,
mandatory

company

Company data. Used for business accounts only.

structured,
(apenas contas empresariais)

├─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

Birth country. 3 letter abbreviation. Example: BRA.

string

businessSegment

Business category.

structured

└─id

Category identifier, according to the list of categories. See here 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