These docs are for v2.1. Click to read the latest docs for v4.1.

account

CampoTipoDescrição
typeENUMTipo de conta que deve ser criada. Valores possíveis: BUYER (comprador), SELLER (vendedor).
idString (47 caracteres)id da conta. Formato: ACCO_XXXXXXXXXXXX
business_categoryENUMClassificação do negócio que deve ser informada para toda conta com type SELLER
emailString (60 caracteres)E-mail utilizado no login da conta.
personObjectDados do dono da conta ou de um sócio em caso de contas para empresas. Apenas um sócio deverá ser informado para esse caso.
└──nameString (50 caracteres)Nome completo do usuário ou do sócio
└──birth_dateDatetimeData de nascimento do usuário ou do sócio. Formato a ser informado: yyyy-MM-dd
└──mother_nameString (50 caracteres)Nome da mãe do dono da conta ou do sócio.
└──tax_idInt (20 caracteres)CPF do dono da conta ou do único sócio a ser informado.
└──addressObjectObjeto Address contendo as informações do endereço do dono da conta ou sócio da empresa
companyObjectDados de cadastro da empresa em caso de contas para pessoas jurídicas (Seller).
└──nameString (140 caracteres)Razão Social
└──tax_idInt (20 caracteres)CNPJ
└──addressObjectObjeto Address contendo as informações do endereço da empresa
└──phonesArray of ObjectObjeto Phone contendo uma lista de telefones da empresa.
created_atDatetimeData e horário em que foi criada o recurso de accounts.
tos_accpetanceObjectAceite do termos de aceite por parte do dono da conta na plataforma do parceiro.
└──user_ipString (50 caracteres)IP que identifica o dispositivo em que o dono da conta concordou com os termos de aceite na plataforma do parceiro.
└──dateDatetimeMomento em que o usuário concordou com os termos de aceite na plataforma do parceiro.
tokenObjectConjunto de informações atrelados ao token gerado que relaciona a conta do parceiro e a conta criada por ele (vendedor ou comprador)
└──refresh_tokenString (100 caracteres)Token para atualizar o access_token.
└──token_typeString (ENUM)Sempre terá um valor de bearer.
└──access_tokenString (100 caracteres)Token de acesso e autenticação.
└──expires_inInt (10 caracteres)Tempo de validade do access_token.
└──scopeString (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.