Domicílios bancários
Visão geral
Section titled “Visão geral”Rotas aninhadas em /api/v1/integracao/produtores/{produtorId}/domicilios-bancarios.
A listagem retorna um objeto DomicilioBancarioViewResponse com:
eligible— se o produtor pode usar domicíliosstatusMessage— motivo quando não elegívelaccounts— lista de contas
Operações
Section titled “Operações”| Método | Path | Uso |
|---|---|---|
GET |
.../domicilios-bancarios |
Listar + elegibilidade |
POST |
.../domicilios-bancarios |
Cadastrar conta |
PUT |
.../domicilios-bancarios/{domicilioId} |
Atualizar |
DELETE |
.../domicilios-bancarios/{domicilioId} |
Excluir |
PUT |
.../domicilios-bancarios/{domicilioId}/padrao |
Definir padrão |
Cadastro
Section titled “Cadastro”DomicilioBancarioRequest exige banco, agência, conta, tipo (CORRENTE ou POUPANCA), titular e documento. Chave Pix e dígitos são opcionais.
O domicílio padrão é usado em saques sem distribuição explícita entre contas.
Referência
Section titled “Referência”Schemas e exemplos: referência da API.