Listar Contas

O módulo de listagem de contas permite consultar informações sobre contas digitais criadas através do processo de onboarding. Este módulo está disponível após a conclusão do onboarding e criação da conta.

Visão Geral

Através deste módulo você pode:

• Listar todas as contas vinculadas ao parceiro
• Consultar detalhes da conta
• Verificar informações de contratos associados às contas

Autenticação

Todas as rotas de listagem de contas requerem:

• Token JWT no header Authorization (autenticação auth:api) - quando aplicável

Endpoints Disponíveis

Listar Contas

GET /api/v2/baas/contracts

Lista todas as contas (contratos) associadas ao seller autenticado.

Headers

Parâmetros de Query

Resposta de Sucesso (200)

{
  "data": [
    {
      "id": 123,
      "account_id": 456,
      "account_number": "12345-6",
      "account_type": "current",
      "status": "active",
      "customer": {
        "id": 789,
        "name": "João da Silva Santos",
        "document": "12345678901"
      },
      "created_at": "2025-01-10 10:00:00",
      "updated_at": "2025-01-15 14:30:00"
    }
  ],
  "current_page": 1,
  "per_page": 15,
  "total": 1,
  "last_page": 1
}

Consultar detalhes da Conta

Endpoint para obter os dados da conta autênticada.

GET /api/v2/baas/contracts/show

Headers

Resposta de Sucesso (200)

{
  "id": 123,
  "account_id": 456,
  "account_number": "12345-6",
  "account_type": "current",
  "status": "active",
  "customer": {
    "id": 789,
    "name": "João da Silva Santos",
    "document": "12345678901",
    "email": "[email protected]",
    "phone": "11987654321"
  },
  "balance": {
    "available": "1.234,56",
    "blocked": "0,00"
  },
  "created_at": "2025-01-10 10:00:00",
  "updated_at": "2025-01-15 14:30:00"
}

Respostas de Erro

400 - Conta Não Encontrada

{
  "message": "Account not found"
}

401 - Não Autenticado

{
  "message": "Unauthorized"
}

403 - Acesso Negado

{
  "message": "Forbidden"
}

429 - Rate Limit Excedido

{
  "message": "Too Many Requests"
}

Próximos Passos

Após listar as contas, você pode:

1. Encerrar uma Conta
2. Consultar Saldo de uma conta específica
3. Consultar Extrato de uma conta específica