Endpoints

Todos os caminhos são relativos a https://seventyonepay.online/api/v1. A coluna Permissão é a permissão da chave necessária; Idem. indica que o header Idempotency-Key é obrigatório; Pág. indica listagem paginada.

A lista completa e atualizada está em /openapi.json.

Sistema

Método	Caminho	Descrição	Permissão
GET	/health	Verifica se a API está no ar	pública
GET	/openapi.json	Especificação OpenAPI	pública
GET	/me	Chave em uso e lojista vinculado	qualquer chave
GET	/api-key	Metadados da chave em uso	qualquer chave

Pagamentos e PIX

Método	Caminho	Descrição	Permissão	Idem.	Pág.
GET	/payments	Lista pagamentos	payments:read		sim
POST	/payments	Cria um pagamento	payments:create	sim
GET	/payments/{id}	Detalha um pagamento	payments:read
POST	/pix	Cria uma cobrança PIX	payments:create	sim
GET	/pix/{id}	Detalha uma cobrança PIX	payments:read
POST	/pix/{id}/cancel	Cancela uma cobrança PIX	payments:create
POST	/pix/{id}/sync	Sincroniza o status	payments:create
GET	/pix/{id}/events	Histórico de status	payments:read
GET	/pix/payment/{paymentId}	PIX a partir do pagamento	payments:read

Detalhes de criação em Cobranças PIX.

Clientes

Método	Caminho	Descrição	Permissão	Pág.
GET	/customers	Lista clientes	customers:read	sim
POST	/customers	Cadastra um cliente	customers:create
GET	/customers/{id}	Detalha um cliente	customers:read
PUT	/customers/{id}	Atualiza um cliente	customers:update

Saques

Método	Caminho	Descrição	Permissão	Idem.	Pág.
GET	/withdrawals	Lista saques	withdrawals:read		sim
POST	/withdrawals	Solicita um saque	withdrawals:create	sim
GET	/withdrawals/quote	Simula as taxas de um saque (?amount=)	withdrawals:read
GET	/withdrawals/{id}	Detalha um saque	withdrawals:read

Extrato e tarifas

Método	Caminho	Descrição	Permissão
GET	/ledger	Lançamentos do extrato	payments:read
GET	/ledger/{id}	Detalha um lançamento	payments:read
GET	/fee-rules	Regras de tarifa	fee_rules:read
GET	/fee-rules/{id}	Detalha uma regra de tarifa	fee_rules:read
GET	/reconciliations	Conciliações	reconciliations:read
GET	/reconciliations/{id}	Detalha uma conciliação	reconciliations:read

Relatórios

Método	Caminho	Descrição	Permissão
GET	/reports/dashboard	Indicadores resumidos	reports:read
GET	/reports/payments	Relatório de pagamentos	reports:read
GET	/reports/pix	Relatório de PIX	reports:read
GET	/reports/wallet	Relatório de carteira	reports:read
GET	/reports/ledger	Relatório do extrato	payments:read
GET	/reports/export	Exportação	reports:read

Entregas de webhook

Método	Caminho	Descrição	Permissão
GET	/webhook-deliveries	Lista entregas	webhooks:read
GET	/webhook-deliveries/{id}	Detalha uma entrega	webhooks:read
POST	/webhook-deliveries/{id}/retry	Reenvia uma entrega	webhooks:manage

Veja Entregas e retentativas.

Outros

Também existem endpoints de leitura de risco (/risk/limits, /risk/events), tarefas (/jobs), notificações (/notifications) e auditoria (/audit). Eles exigem permissões específicas (risk:read, jobs:read, notifications:read, audit:read) e estão descritos no OpenAPI.