{"templateId":"markdown","versions":[{"version":"v2026.04","label":"v2026.04","link":"/pt-br/products/payments-direct-2/api-docs/integration-resources/payload-schema-utility","default":true,"active":true,"folderId":"7e5507fe"},{"version":"v2026.03","label":"v2026.03","link":"/pt-br/products/payments-direct-2/v2026.03/api-docs/integration-resources/payload-schema-utility","default":false,"active":false,"folderId":"7e5507fe"},{"version":"v2025.11","label":"v2025.11","link":"/pt-br/products/payments-direct-2/v2025.11/api-docs/integration-resources/payload-schema-utility","default":false,"active":false,"folderId":"7e5507fe"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/pt-BR/products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","direct2CombinedDataRequirementsPicker"]},"type":"markdown"},"seo":{"title":"Utilitário de Schema de Payload","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"utilitário-de-schema-de-payload","__idx":0},"children":["Utilitário de Schema de Payload"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use esta ferramenta interativa para gerar o schema JSON exato para criar tokens de identidade e de instrumento financeiro em qualquer corredor compatível do ","Payments Direct","."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Os requisitos de campo variam conforme o payment rail, o tipo de beneficiário, o tipo de ordenante e o caso de uso. Este utilitário filtra o schema para o seu cenário específico e mostra apenas os campos que você precisa enviar."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"como-usar-o-utilitário","__idx":1},"children":["Como usar o utilitário"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Faça as seleções na ordem abaixo. Cada etapa restringe o schema ao seu cenário."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tipo de identidade"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INDIVIDUAL"]}," ou ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Papel de pagamento"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORIGINATOR"]}," (remetente) ou ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BENEFICIARY"]}," (recebedor)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Jurisdição"]}," — a região regulatória em que a sua organização está registrada. Essa é uma propriedade da sua organização, e não do pagamento, portanto o que ela exige se aplica a todos os métodos de pagamento e não muda conforme a parte para quem você transaciona. Mantenha a opção ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Não aplicável"]}," a menos que a Ripple tenha registrado a sua organização em alguma jurisdição."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tipo de instrumento financeiro"]}," — o payment rail, como ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EU_SEPA"]}," ou ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR_PIX"]},". Esta seleção determina os campos condicionais obrigatórios para a identidade."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"o-que-o-utilitário-retorna","__idx":2},"children":["O que o utilitário retorna"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tabela de requisitos."]}," Uma visão tabular e de leitura rápida dos campos exigidos pelo cenário selecionado, com restrições de comprimento e de padrão. Use-a como referência rápida durante a integração. Campos que o corredor não exige não são listados; os schemas abaixo trazem o conjunto completo. Cada campo é marcado com um de dois estados:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Obrigatório."]}," A chamada ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/api-docs/developer-guides/create-and-manage-identities"},"children":["Criar uma identidade"]}," ou ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/api-docs/developer-guides/create-and-manage-financial-instruments"},"children":["Adicionar um instrumento financeiro"]}," falha com um 400 se você omitir o campo."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Obrigatório no pagamento."]}," A identidade ou o instrumento é aceito sem o campo, mas um pagamento que precise dele é rejeitado. São valores que o parceiro pagador exige na execução, e não no onboarding, portanto o campo não é cobrado até você enviar um pagamento. Ainda assim, preencha-os durante o onboarding: um pagamento bloqueado nessa etapa exige a atualização da identidade antes de ser tentado novamente."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Schema de identidade."]}," O JSON Schema completo do corpo da requisição ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/api-docs/developer-guides/create-and-manage-identities"},"children":["Criar uma identidade"]},", incluindo campos opcionais que a tabela acima omite. Campos condicionais (como ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]}," ou ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registration"]},") são promovidos automaticamente para a lista ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," do schema quando se aplicam ao papel de pagamento e ao payment rail selecionados. Clique em ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Baixar schema"]}," para salvar o JSON localmente e usá-lo em geradores de código de cliente."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Schema de instrumento financeiro."]}," O JSON Schema completo do corpo da requisição ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/api-docs/developer-guides/create-and-manage-financial-instruments"},"children":["Adicionar um instrumento financeiro"]},", novamente incluindo campos opcionais, com o objeto do payment rail (como ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usAch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["euSepa"]}," ou ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brPix"]},") e os metadados que descrevem os corredores de moeda compatíveis. Clique em ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Baixar schema"]}," para salvar."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Os requisitos de jurisdição estão incluídos"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Selecionar uma jurisdição acrescenta os campos que ela exige aos requisitos do próprio corredor, em todos os métodos de pagamento. Mantenha a opção ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Não aplicável"]}," se a Ripple não tiver registrado a sua organização em nenhuma. Consulte ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/introduction/concepts/payment-identities#requisitos-por-jurisdi%C3%A7%C3%A3o"},"children":["Requisitos por jurisdição"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"faça-suas-seleções","__idx":3},"children":["Faça suas seleções"]},{"$$mdtype":"Tag","name":"Direct2CombinedDataRequirementsPicker","attributes":{},"children":[]}]},"headings":[{"value":"Utilitário de Schema de Payload","id":"utilitário-de-schema-de-payload","depth":1},{"value":"Como usar o utilitário","id":"como-usar-o-utilitário","depth":2},{"value":"O que o utilitário retorna","id":"o-que-o-utilitário-retorna","depth":2},{"value":"Faça suas seleções","id":"faça-suas-seleções","depth":2}],"frontmatter":{"title":"Utilitário de Schema de Payload","description":"Gere o schema JSON exato para criar tokens de identidade e de instrumento financeiro em qualquer corredor compatível.","seo":{"title":"Utilitário de Schema de Payload"}},"lastModified":"2026-10-21T01:29:12.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pt-br/products/payments-direct-2/api-docs/integration-resources/payload-schema-utility","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}