Objeto Account

Este objeto é responsável por apresentar todos os dados disponíveis para criar uma conta.

Atributos

type ENUM
Tipo de conta a ser criada.
Valores de ENUM:

  • BUYER (comprador).
  • SELLER (vendedor).

id String (47 caracteres)
Identificador único da conta. Formato: ACCO_XXXXXXXXXXXX
Exemplo: ACCO_123456789000

business_category ENUM
Classificação do negócio. Deve ser informada para toda conta com type = SELLER.
Valores de ENUM:

  • Açougue - BUTCHERY
  • Advogados e Serviços Legais - LEGAL_SERVICE
  • Alfaiates / Costureiras - TAILOR_AND_SEAMSTRESS
  • Arquiteto e Engenheiro - ARCHITECTURAL_AND_ENGINEERING
  • Arte e Antiguidades - ART_AND_ANTIQUE
  • Artigos Religiosos - RELIGION_AND_SPIRITUALITY
  • Automóveis e Acessórios - VEHICLE_AND_PARTS
  • Borracheiro / Mecânico / Funilaria / Pintura - VEHICLE_SERVICES
  • Cabelereiro / Barbeiro / Manicure - BEAUTY_AND_BARBER
  • Chaveiro - KEY_CHAIN
  • Comércio de bebidas - PACKAGE_STORE
  • Comércio Varejista de Alimentos - FOOD_RETAIL
  • Conteúdo Adulto - ADULT_CONTENT
  • Corretor de imobiliária - REAL_ESTATE_AGENT
  • Corretor de seguro - BROKER
  • Dentista / Ortodontista - DENTISTRY
  • Despachante - FREIGHT_FORWARDER
  • Eletrônicos / Eletrodomésticos - HOUSEHOLD_APPLIANCE
  • Empreiteiros Autônomos - GENERAL_CONTRACTOR
  • Entidades Públicas - GOVERNMENT
  • Esteticista / Massagista - HEALTH_AND_BEAUTY_SERVICE
  • Feira Livre - NONDURABLE_GOODS
  • Fisioterapeutas / Fonoaudiólogos / Nutricionista / Psicólogo / Enfermeiros - MEDICAL_SERVICE
  • Fotografia e gravação - PHOTOGRAPHY_AND_VIDEO
  • Hipermercado / mercado / minimercado - SUPERMARKET
  • Hospedagem e Turismo - LODGING
  • Jardineiro/Florista/Paisagista - FLORIST
  • Jóias e Relógios - JEWELRY_AND_WATCH
  • Marceneiros / Serralheiros / Vidraceiros - OTHER_SERVICES
  • Padaria - BAKERY
  • Personal Trainer - PERSONAL_TRAINER
  • Pet Shop - PET_SUPPLIES
  • Podólogos / Pedicuros - PODIATRIST_AND_CHIROPODIST
  • Prestadores Serviços - PROFESSIONAL_SERVICE
  • Reparos diversos - REPAIR_SHOPS
  • Restaurantes e similares - RESTAURANT
  • Roupas e Acessórios - CLOTHING_AND_ACCESSORIES
  • Serviço de celular e telefonia - MOBILE_SERVICE
  • Serviços de Educação - EDUCATION
  • Serviços de recreação e lazer - ENTERTAINMENT
  • Tatuadores - TATTOOIST
  • Táxi - Autonomos - TRANSPORTATION_SERVICE
  • Utensílios Domésticos - HOUSE_HOLD
  • Vendas à Domicílio - DOOR_TO_DOOR_SALES
  • Veterinários - VETERINARY_SERVICE

email String (60 caracteres)
E-mail utilizado no login da conta.
Exemplo: [email protected]

person Object

Dados do proprietário da conta ou de um sócio em caso de contas para empresas. Apenas um sócio deverá ser informado para esse caso.

name String (50 caracteres)
Nome completo do usuário ou do sócio.
Exemplo: José Carlos Silva

birth_date Datetime
Data de nascimento do usuário ou do sócio. Formato a ser informado: yyyy-MM-dd
Exemplo: 1991-10-10

mother_name String (50 caracteres)
Nome da mãe do dono da conta ou do sócio.
Exemplo: Maria Silva

tax_id Int (20 caracteres)
CPF do dono da conta ou do sócio.
Exemplo: 12345678900

address Object

Contém informações do endereço de entrega do pedido.

street String (1-160 caracteres)
Rua do endereço.
Exemplo: Avenida Brigadeiro Faria Lima

number String (1-20 caracteres)
Número do endereço.
Exemplo: 1384

complement String (1-40 caracteres)
Complemento do endereço.
Exemplo: Casa

locality String (1-60 caracteres)
Bairro do endereço.
Exemplo: Pinheiros

city String (1-90 caracteres)
Cidade do endereço.
Exemplo: São Paulo

region String (1-50 caracteres)
Nome do Estado.
Exemplo: São Paulo

region_code String (2 caracteres)
Código do Estado (Padrão ISO 3166-2).
Exemplo: SP

country String (1-50 caracteres)
País do endereço (Padrão ISO 3166-1 alpha-3).
Exemplo: BRA

postal_code String (8 caracteres)
CEP do endereço.
Exemplo: 01452002

company Object

Dados de cadastro da empresa em caso de contas para pessoas jurídicas (Seller).

name String (140 caracteres)
Razão Social da empresa.
Exemplo: José Carlos Silva

tax_id Int (20 caracteres)
CNPJ da empresa.
Exemplo: 1991-10-10

address Object

Contém informações do endereço de entrega do pedido.

street String (1-160 caracteres)
Rua do endereço.
Exemplo: Avenida Brigadeiro Faria Lima

number String (1-20 caracteres)
Número do endereço.
Exemplo: 1384

complement String (1-40 caracteres)
Complemento do endereço.
Exemplo: Casa

locality String (1-60 caracteres)
Bairro do endereço.
Exemplo: Pinheiros

city String (1-90 caracteres)
Cidade do endereço.
Exemplo: São Paulo

region String (1-50 caracteres)
Nome do Estado.
Exemplo: São Paulo

region_code String (2 caracteres)
Código do Estado (Padrão ISO 3166-2).
Exemplo: SP

country String (1-50 caracteres)
País do endereço (Padrão ISO 3166-1 alpha-3).
Exemplo: BRA

postal_code String (8 caracteres)
CEP do endereço.
Exemplo: 01452002

phones Array of Object

Contém informações sobre a lista de telefones da empresa.

phone Object

Informações do telefone.

country Int (3 caracteres)
Código de operadora do País (DDI).
Exemplo: 55

area Int (2 caracteres)
Código de operadora local (DDD).
Exemplo: 021

number Int (8-9 caracteres)
Número do telefone.
Exemplo: 123456789

type String (ENUM)
Indica o tipo de telefone.
Valores de ENUM:

  • MOBILE se for um telefone celular.
  • BUSINESS se for um telefone comercial.
  • HOME se for um telefone residencial.

created_at Datetime
Data e horário em que foi criado a conta.
Exemplo: 2021-07-23T15:17:12.115601-03:00

tos_accpetance Object

Aceite dos termos de aceite por parte do dono da conta na plataforma do parceiro.

user_ip String (50 caracteres)
IP que identifica o dispositivo em que o dono da conta concordou com os termos de aceite na plataforma do parceiro.
Exemplo: 127.0.0.1

date Datetime
Momento em que o usuário concordou com os termos de aceite na plataforma do parceiro.
Exemplo: 2019-04-17T20:07:07.002-02

token Object

Conjunto de informações atreladas ao token gerado que relaciona a conta do parceiro e a conta criada por ele (vendedor ou comprador).

refresh_token String (100 caracteres)
Token para atualizar o access_token.
Exemplo: 123

token_type String (ENUM)
Sempre terá um valor de bearer.
Exemplo: Bearer

access_token String (100 caracteres)
Token de acesso e autenticação.
Exemplo: 123

expires_in Int (10 caracteres)
Tempo de validade do access_token.
Exemplo: 123456

scope String (150 caracteres)
Permissões que foram concedidas. Para contas tipo BUYER, o único escopo possível é o accounts.read. Para contas tipo SELLER, os escopos criados são accounts.read e payments.create.
Exemplo: accounts.read