Pular para o conteúdo principal

Índice da referência da API

Cada página abaixo traz exemplos cURL com {{BASE_URL}} e {{TOKEN}}. A URL base documentada é https://paychain-api.onrender.com. A especificação formal continua em backend/doc/openapi.yaml no repositório.

Páginas por área

ÁreaDocumentação
SaúdeGET /health
Login (JWT)POST /auth/login
Perfil e webhookGET/PATCH /users/me, senha
CarteirasGET/POST/DELETE wallets
OrdensPOST /orders, listagem, submit-tx, auditoria…
Pagamento públicotx-request, submit-tx, info
DashboardGET dashboard/summary

Tabela resumo (método + caminho)

Saúde

MétodoCaminho
GET/health

Autenticação

MétodoCaminhoNota
POST/auth/loginDocumentado para integração.
POST/auth/registerExiste na API; cadastro de cliente é pelo site/painel, não coberto nesta doc.

Perfil

MétodoCaminho
GET/users/me
PATCH/users/me
POST/users/me/password

Carteiras

MétodoCaminho
GET/users/me/wallets
POST/users/me/wallets
DELETE/users/me/wallets/:id

Ordens

MétodoCaminho
POST/orders
GET/users/me/orders
GET/orders/:reference
POST/orders/:reference/submit-tx
GET/orders/:reference/webhook-deliveries
GET/orders/:reference/telegram-deliveries
GET/orders/:reference/audit

Pagamento (público)

MétodoCaminho
GET/pay/tx-request/:reference
POST/pay/:reference/submit-tx
GET/pay/:reference/info (e relacionadas)

Dashboard

MétodoCaminho
GET/users/me/dashboard/summary

Postman

Importe backend/doc/Paychain-API.postman_collection.json e configure base_url (ex.: https://paychain-api.onrender.com) e token.

Variáveis nos exemplos

Ver cURL e variáveis.