docs: alinhar contrato ao backend (signup, cash-in/out, webhooks, cenários) - #4
Merged
Merged
Conversation
Backend é a fonte da verdade (whitelist + forbidNonWhitelisted).
- signup: contrato novo (required email/holderName/entityType + razonSocial
condicional; holderTaxIdPrimary opcional; holderTaxIdPrimaryType/accountType
deprecados; isSandbox default true).
- spei cash-in/out: required corretos; remove aliases Voluti (rejeitados pelo
backend); CLABE somente 18 dígitos; remove externalId do cash-out.
- get-started: adiciona customerEmail no exemplo de cash-in.
- webhooks: events = exatamente 1.
- X-Sandbox-Scenario: padroniza nos valores canônicos (corrige cash_in_failed,
error:*, delayed:Ns).
- openapi: adiciona paths /balance, /transactions, /webhooks-config/test;
remove path fantasma /spei/transaction/{externalId}.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…dor) - Deleta os guias en/es migrating-from-voluti.mdx (expunham Voluti/magenpay e ainda prometiam aliases já removidos). - Remove os Cards "Migrating from Voluti" dos index en/es. Todos os integradores são clientes NTX; Voluti não aparece na doc pública. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Alinha a doc ao contrato real do backend (public-ms = fonte da verdade;
whitelist + forbidNonWhitelisted)openapi.json
required= email/holderName/entityType; +razonSocial condicional; holderTaxIdPrimary opcional; holderTaxIdPrimaryType/accountType deprecados; isSandbox default truerequiredcorretos; remove aliases Voluti (amount/payer_name/conciliationId/receiverClabe/receiverName/bankCode) — backend rejeita; CLABE só 18 dígitos; remove externalId do cash-outevents: exatamente 1 (era 1–5)/api/balance,/api/transactions,/api/webhooks-config/test/api/spei/transaction/{externalId}(sem rota no backend)Guias (pt-br/en/es)
customerEmailno exemplo de cash-in (antes daria 400)cash_in_failed,error:*,delayed:Ns)migrating-from-voluti.mdxainda promete os aliases Voluti removidos — fora deste PR.🤖 Generated with Claude Code