Contas Bancárias
Gerencie as contas bancárias dos issuers para emissão de boletos.
Cadastrar Conta Bancária
POST /issuers/:issuerId/bank-accounts
Autenticação
x-api-key: {apiKey}
Parâmetros Obrigatórios
| Campo | Tipo | Descrição |
|---|---|---|
banco | string | Código do banco (ex: "756" = Sicoob) |
agencia | string | Número da agência |
conta | string | Número da conta |
Parâmetros Opcionais
| Campo | Tipo | Descrição |
|---|---|---|
bancoNome | string | Nome do banco (ex: "Sicoob") |
agenciaDigito | string | Dígito da agência |
contaDigito | string | Dígito da conta |
convenio | string | Código do convênio |
carteira | string | Código da carteira |
codigoCedente | string | Código do cedente |
clientId | string | Client ID da API do banco (para registro online) |
clientSecret | string | Client Secret da API do banco |
description | string | Descrição da conta |
Exemplo
curl -X POST https://api.engineapi.com.br/issuers/ISSUER_ID/bank-accounts \
-H "x-api-key: SUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"banco": "756",
"bancoNome": "Sicoob",
"agencia": "3001",
"agenciaDigito": "0",
"conta": "12345",
"contaDigito": "6",
"convenio": "1234567",
"carteira": "1",
"codigoCedente": "12345",
"clientId": "your-client-id",
"clientSecret": "your-client-secret"
}'
Resposta (201)
{
"success": true,
"message": "Conta Sicoob (3001/12345) cadastrada com sucesso",
"data": {
"id": "uuid-da-conta",
"banco": "756",
"bancoNome": "Sicoob",
"agencia": "3001",
"conta": "12345",
"isActive": true
}
}
Listar Contas Bancárias
GET /issuers/:issuerId/bank-accounts
Exemplo
curl https://api.engineapi.com.br/issuers/ISSUER_ID/bank-accounts \
-H "x-api-key: SUA_API_KEY"
Resposta (200)
{
"success": true,
"data": [
{
"id": "uuid",
"banco": "756",
"bancoNome": "Sicoob",
"agencia": "3001",
"conta": "12345",
"isActive": true
}
],
"total": 1
}