docs: reorganiza Guia/Sandbox/Webhooks e corrige payloads pelo contrato real - #7
Merged
Merged
Conversation
…real - Sandbox reduzido a 3 páginas (introdução, cenários, webhooks simulados); remove duplicação de endpoints (auth/cash-in/cash-out) que divergia dos guias - Payload de webhook corrigido para o formato real: flat (event, transactionId, amount, currency, status, clabes, occurredAt), eventos transaction.cash_*.*, status LIQUIDATED/REJECTED/RETURNED/PENDING - Headers reais: x-event-id (dedupe) + X-NTXPay-Signature; remove X-NTXPay-Delivery/Timestamp/Event que não existem - Retry unificado: 5 tentativas, backoff exponencial, timeout 10s - Semântica de refund_in/refund_out corrigida (estava invertida) - Documenta evento curinga 'all' e POST /api/webhooks-config/test (+ stub e nav) - Remove referências internas (Banxico, TigerBeetle, outbox, nomes de MS) - Aplica o modelo nas 3 línguas (pt-br, es, en) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
O que muda
Reorganização completa da doc pública (pt-br, es, en) no modelo Guia → Sandbox → Webhooks, eliminando as repetições de cash-in/sandbox e corrigindo os payloads pelo contrato real do backend (
public-ms/mexico-ms/notification-ms, branchhml).Estrutura
X-Sandbox-Scenario) e webhooks simulados. Deletadassandbox/authentication,sandbox/cash-in,sandbox/cash-out(re-documentavam endpoints e divergiam dos guias)Correções de contrato (verificadas no código, hml)
event,transactionId,amount,currency,status,destinationClabe,sourceClabe,reference,voucher,occurredAt) com eventostransaction.cash_in.settledetc. e statusLIQUIDATED/REJECTED/RETURNED/PENDING— a doc mostrava um envelope{event, deliveryId, transaction:{...}, errorCode}que não existex-event-id(dedupe) +X-NTXPay-Signature; removidosX-NTXPay-Delivery/Timestamp/Event(não são enviados)refund_in= devolução de um cash-in;refund_out= devolução de um cash-out; eventos*.returnedsão entregues nesses webhooksall(Geral) e oPOST /api/webhooks-config/test(stub + navegação + enum no openapi.json)GET /api/transactions/GET /api/spei/transaction/{externalId}(não documentados)Sem referências internas
Removidos Banxico, TigerBeetle, outbox e nomes de microsserviços (inclusive nas descrições 502 do
openapi.json). O valorprovider_5xxfoi mantido por ser literal do contrato do headerX-Sandbox-Scenario, mas descrito de forma neutra.Verificações
docs.json) atualizada nas 3 línguas🤖 Generated with Claude Code