Aparência
Gestão — Conta
Prefixo base: /access
Todas as rotas (exceto as de auth) requerem autenticação JWT + conta ativa.
Headers obrigatórios:
Authorization: Bearer {token}
Content-Type: application/json
account: {account_id}Conta
GET /access/account
Retorna os dados da conta ativa do usuário.
Response 200:
json
{
"data": {
"id": 3,
"name": "Minha Empresa LTDA",
"document": "12345678000199",
"email": "financeiro@empresa.com",
"phone": "+5511988887777",
"bank_id": 26,
"tax_boleto": 2.5,
"tax_bolepix": 3.0,
"min_pix_in": 1.0,
"created_at": "2024-01-10T08:00:00.000000Z"
}
}PUT /access/account
Atualiza os dados da conta ativa.
Body:
json
{
"name": "Empresa Atualizada LTDA",
"email": "novo@email.com",
"phone": "(11) 98888-7777",
"document": "12345678000199",
"pin": "123456",
"new_pin": "654321"
}| Campo | Tipo | Obrigatório | Regras |
|---|---|---|---|
name | string | Não | máx. 50 caracteres |
email | string | Não | só aceita o e-mail atual (ou vazio): para trocar, use troca verificada. Também é o valor da chave Pix do tipo e-mail |
phone | string | Não | só aceita o celular atual, com ou sem máscara, ou null (apaga): para trocar, use troca verificada. Gravado como +55DDDNÚMERO; também é o valor da chave Pix do tipo celular |
document | string | Não | não pode ser alterado: só passa igual ao atual (com ou sem máscara); outro valor → 422 |
pin | string | Condicional | 6 dígitos numéricos; obrigatório para alterar new_pin |
new_pin | string | Não | 6 dígitos; não pode ser sequência óbvia |
credentials.fiducia_transactional_password | string | Não | Senha transacional da Fidúcia, usada nas rotas de gestão de chave Pix. Guardada criptografada; nunca devolvida pela API. |
credentials.fiducia_password | string | Não | Senha de acesso da conta na Fidúcia, usada no login da própria conta (POST /login). Guardada criptografada; nunca devolvida pela API. Alterar descarta a sessão atual. |
credentials.fiducia_operator_code | string | Não | Código do operador (cod_operador) do login PJ na Fidúcia. Alterar descarta a sessão atual. |
Response 200:
json
{
"data": {
"id": 3,
"name": "Empresa Atualizada LTDA"
},
"message": "Conta atualizada com sucesso."
}GET /access/accounts
Lista todas as contas vinculadas ao usuário autenticado.
Response 200:
json
[
{
"id": 3,
"name": "Minha Empresa LTDA",
"document": "12345678000199"
},
{
"id": 7,
"name": "Segunda Empresa ME",
"document": "98765432000100"
}
]Como selecionar conta: Envie account: {id} no header das próximas requisições.