API do BaaS

31 endpoints em 6 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

32 endpoints

Configurações de provedor

/baas/api/v1/provider-configs7

POST/baas/api/v1/provider-configsCria config, testa a conexão e cifra as credenciais. 201BAAS_ADMIN
GET/baas/api/v1/provider-configsLista, paginado. Filtros filter[providerType], filter[isActive]BAAS_READ
GET/baas/api/v1/provider-configs/:idBusca por IDBAAS_READ
PATCH/baas/api/v1/provider-configs/:idAtualiza. Se enviar credentials, testa antes de gravarBAAS_ADMIN
DELETE/baas/api/v1/provider-configs/:idExclusão lógica. 204BAAS_ADMIN
POST/baas/api/v1/provider-configs/:id/set-defaultMarca como padrão e desmarca as outrasBAAS_ADMIN
POST/baas/api/v1/provider-configs/:id/testTesta a conexão com as credenciais gravadasBAAS_ADMIN

/baas/api/v1/accounts9

POST/baas/api/v1/accountsAbre conta no provedor e registra localmente. 201BAAS_ADMIN
GET/baas/api/v1/accountsLista, paginado. Filtros filter[status], filter[personId], filter[configId]BAAS_READ
GET/baas/api/v1/accounts/:idBusca por IDBAAS_READ
PATCH/baas/api/v1/accounts/:idAtualiza titular no provedor e/ou metadata localBAAS_ADMIN
POST/baas/api/v1/accounts/:id/closeEncerra a conta. Exige reasonBAAS_ADMIN
GET/baas/api/v1/accounts/:id/balanceSaldo **consultado no provedor** a cada chamadaBAAS_READ
POST/baas/api/v1/accounts/:id/kycEnvia documentos de KYCBAAS_ADMIN
GET/baas/api/v1/accounts/:id/kycConsulta o status de KYC no provedorBAAS_READ
POST/baas/api/v1/accounts/:id/sandbox/deposit**Só MockBank.** Credita saldo para testeBAAS_ADMIN

/baas/api/v1/pix10

POST/baas/api/v1/pix/keysRegistra chave Pix. 201BAAS_ADMIN
GET/baas/api/v1/pix/keysLista chaves. **Exige ?accountId=**, senão 400BAAS_READ
DELETE/baas/api/v1/pix/keys/:idRemove a chave no provedor e marca deletedAt. 204BAAS_ADMIN
POST/baas/api/v1/pix/keys/lookupConsulta o DICT: quem é dono de uma chaveBAAS_READ
GET/baas/api/v1/pix/transfersLista transações Pix da organização, com dados da contaBAAS_READ
POST/baas/api/v1/pix/transfersInicia transferência Pix. 201BAAS_ADMIN
GET/baas/api/v1/pix/transfers/:idConsulta e **sincroniza** o status com o provedorBAAS_READ
POST/baas/api/v1/pix/transfers/:id/refundDevolve um Pix recebido. 201BAAS_ADMIN
POST/baas/api/v1/pix/qr-codes/generateGera QR Code estático ou dinâmicoBAAS_ADMIN
POST/baas/api/v1/pix/qr-codes/decodeDecodifica um código EMVBAAS_READ

/baas/api/v1/ted3

POST/baas/api/v1/tedInicia transferência TED. 201BAAS_ADMIN
GET/baas/api/v1/tedLista transações TED. Aceita ?accountId= ou os mesmos filtros do PixBAAS_READ
GET/baas/api/v1/ted/:idConsulta e **sincroniza** o status com o provedorBAAS_READ

/baas/api/v1/webhooks2

POST/baas/api/v1/webhooks/:providerTypeRecebe webhook do provedor. :providerType é celcoin, fitbank, qitech ou mockbankAssinatura do provedor — **não** usa JWT
GET/baas/api/v1/webhooks/healthSonda simples do subsistema de webhookPública

/baas/health1