Documentação para agentes

Texto puro, curto e sem navegação — feito para caber no contexto de um modelo. Aponte o seu agente para um destes endereços.

/llms.txt Índice: o que o hub faz, onde atende e cada rota.
/llms-full.txt Tudo num arquivo: rotas, campos, enums, erros e exemplos.
/openapi.yaml O contrato OpenAPI, para gerar cliente.

/llms.txt

# Abeesys payments-core

Endereço público: `https://api-payments.abeesys.com`, `https://api-payments.dev.abeesys.com`.

## Autenticação

- `apiKey`: http bearer — `Authorization: Bearer <key>`. API key do tenant (`abs_live_...`), gerada pelo CLI `tenant create`.
- Sem API key: `GET /api/v1/health`, `GET /api/v1/health/ready`, `GET /api/v1/recipient-links/callback`, `POST /api/v1/webhooks/{provider}/{tenantID}`, `POST /api/v1/marketplace-webhooks/{accountID}`, `POST /api/v1/platform-webhooks/{accountID}`.

## Rotas

Os caminhos abaixo são relativos ao endereço da API (`https://api-payments.abeesys.com`, `https://api-payments.dev.abeesys.com`). Um site que só publica esta documentação não os atende.

- `GET /api/v1/health`: Liveness — não toca no banco (sem API key)
- `GET /api/v1/health/ready`: Readiness — confere o banco (sem API key)
- `GET /api/v1/charges`: Lista as cobranças do tenant, da mais recente à mais antiga
- `POST /api/v1/charges`: Cria uma cobrança — o hub escolhe o gateway
- `POST /api/v1/recipients`: Cadastra um recebedor do sistema
- `GET /api/v1/recipients/{id}`: Consulta um recebedor do sistema, com os vínculos
- `POST /api/v1/recipients/{id}/links`: Abre a autorização da conta do recebedor num gateway
- `GET /api/v1/recipient-links/callback`: Volta da autorização do recebedor — quem chama é o navegador dele (sem API key)
- `POST /api/v1/card-forms`: Qual formulário de cartão usar para esta cobrança
- `GET /api/v1/charges/{id}`: Consulta uma cobrança do tenant
- `POST /api/v1/charges/{id}/refunds`: Pede o estorno de uma cobrança capturada, inteiro ou em parte
- `GET /api/v1/charges/{id}/refunds`: Lista os estornos de uma cobrança, do mais antigo ao mais novo
- `GET /api/v1/refunds/{id}`: Consulta um estorno do tenant
- `GET /api/v1/wallets`: Saldo de cada carteira do tenant, por gateway e moeda
- `GET /api/v1/ledger/entries`: Lançamentos do tenant, do mais recente ao mais antigo
- `GET /api/v1/subaccounts`: Saldo de cada subconta virtual do tenant, por gateway e moeda
- `GET /api/v1/subaccounts/entries`: Extrato de uma subconta, do lançamento mais recente ao mais antigo
- `POST /api/v1/webhooks/{provider}/{tenantID}`: Recebe o webhook de um gateway (sem API key)
- `POST /api/v1/marketplace-webhooks/{accountID}`: Recebe o aviso do gateway ao marketplace de uma conta da plataforma (sem API key)
- `POST /api/v1/platform-webhooks/{accountID}`: Recebe o webhook de uma conta da plataforma num gateway (sem API key)

## Avisos que o hub envia ao sistema

- `webhook chargeUpdated`: O aviso de mudança de cobrança — quem implementa é o sistema cliente

## Documentação

- [Documentação completa](/llms-full.txt): rotas, parâmetros, campos, enums, respostas, tipos de erro e exemplos
- [Contrato OpenAPI](/openapi.yaml): o contrato, para gerar cliente