Skip to main content
Subcontas (pessoa física ou jurídica) são criadas sob a conta titular da chave secreta. Cada subconta tem a própria chave secreta, que opera apenas nela. A abertura passa por análise (KYC) antes de a conta ficar ativa.

​
Estrutura (consulta)

​
Atributos

id é o UUID da subconta (o mesmo de account.id). status espelha account.status: pending, active ou closed.
Dados cadastrais. type: individual ou company. status: active, inactive, under_review ou rejected (nasce under_review). documentType: cpf ou cnpj. phone é a string só com dígitos (código do país + DDD + número). Em pessoa física, legalName e tradingName repetem o nome.
Conta bancária: name, status, bankCode e, depois da aprovação, branch, number e digit (null enquanto pending).

​
Resposta de criação

Além dos campos acima, a criação retorna:
  • apiKey — chave secreta da subconta: id, type (secret), secret (texto completo, exibido apenas na criação e na rotação), description, permissions, createdAt, updatedAt. A chave não aparece na listagem de chaves da subconta.
  • paymentMethodConfigurations — tarifas informadas na abertura (vazio se nenhuma foi enviada; métodos omitidos usam o padrão da plataforma).

​
Endpoints

Todos exigem chave secreta (sk_) da conta titular. A listagem desta área usa limit/offset (e não page) e devolve também limit e offset na resposta.