Provider Configs

Gerenciamento de configurações de provedores de Open Finance.

Endpoints

Método	Endpoint	Descrição	Permissão
POST	/api/v1/provider-configs	Criar configuração	OPENFINANCE_ADMIN
GET	/api/v1/provider-configs	Listar configurações	OPENFINANCE_READ
GET	/api/v1/provider-configs/:id	Obter configuração	OPENFINANCE_READ
PATCH	/api/v1/provider-configs/:id	Atualizar configuração	OPENFINANCE_ADMIN
DELETE	/api/v1/provider-configs/:id	Excluir configuração	OPENFINANCE_ADMIN
POST	/api/v1/provider-configs/:id/set-default	Definir como padrão	OPENFINANCE_ADMIN
POST	/api/v1/provider-configs/:id/test	Testar conexão	OPENFINANCE_ADMIN

---

Criar Configuração

POST /api/v1/provider-configs

Cria uma configuração de provedor. As credenciais são validadas via teste de conexão antes de serem salvas.

Request

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome identificador
providerType	string	Sim	Tipo do provedor (PLUGGY, BELVO)
credentials	object	Sim	Credenciais de API do provedor
settings	object	Não	Configurações adicionais
isDefault	boolean	Não	Definir como padrão

cURL

curl -X POST 'https://open-finance.stg.catalisa.app/api/v1/provider-configs' \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Pluggy Produção",
    "providerType": "PLUGGY",
    "credentials": {
      "clientId": "seu-pluggy-client-id",
      "clientSecret": "seu-pluggy-client-secret"
    },
    "isDefault": true
  }'

JavaScript

const response = await fetch('https://open-finance.stg.catalisa.app/api/v1/provider-configs', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Pluggy Produção',
    providerType: 'PLUGGY',
    credentials: {
      clientId: 'seu-pluggy-client-id',
      clientSecret: 'seu-pluggy-client-secret',
    },
    isDefault: true,
  }),
});

const { data } = await response.json();
console.log(`Config criada: ${data.id}`);

Response (201 Created)

{
  "data": {
    "type": "openfinance-provider-config",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "attributes": {
      "name": "Pluggy Produção",
      "providerType": "PLUGGY",
      "isActive": true,
      "isDefault": true,
      "settings": {},
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  }
}

informação

As credenciais são armazenadas de forma criptografada e nunca são retornadas nas respostas da API.

---

Testar Conexão

POST /api/v1/provider-configs/:id/test

Verifica se as credenciais configuradas estão funcionando corretamente.

cURL

curl -X POST 'https://open-finance.stg.catalisa.app/api/v1/provider-configs/550e8400-e29b-41d4-a716-446655440000/test' \
  -H 'Authorization: Bearer SEU_TOKEN'

Response (200 OK)

{
  "success": true,
  "message": "Connection successful"
}

---

Definir como Padrão

POST /api/v1/provider-configs/:id/set-default

Define uma configuração como padrão para a organização. A configuração deve estar ativa.

cURL

curl -X POST 'https://open-finance.stg.catalisa.app/api/v1/provider-configs/550e8400-e29b-41d4-a716-446655440000/set-default' \
  -H 'Authorization: Bearer SEU_TOKEN'

---

Erros Comuns

Código	Erro	Descrição
400	VALIDATION	Credenciais inválidas ou campos obrigatórios ausentes
404	NOT_FOUND	Configuração não encontrada
409	CONFLICT	Nome já existe na organização