Utilitário de Schema de Payload

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.

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.

Faça as seleções na ordem abaixo. Cada etapa restringe o schema ao seu cenário.

1. Tipo de identidade — INDIVIDUAL ou BUSINESS.
2. Papel de pagamento — ORIGINATOR (remetente) ou BENEFICIARY (recebedor).
3. 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 Não aplicável a menos que a Ripple tenha registrado a sua organização em alguma jurisdição.
4. Tipo de instrumento financeiro — o payment rail, como US_ACH, EU_SEPA ou BR_PIX. Esta seleção determina os campos condicionais obrigatórios para a identidade.

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:

• Obrigatório. A chamada Criar uma identidade ou Adicionar um instrumento financeiro falha com um 400 se você omitir o campo.
• 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.

Schema de identidade. O JSON Schema completo do corpo da requisição Criar uma identidade, incluindo campos opcionais que a tabela acima omite. Campos condicionais (como dateOfBirth ou registration) são promovidos automaticamente para a lista required do schema quando se aplicam ao papel de pagamento e ao payment rail selecionados. Clique em Baixar schema para salvar o JSON localmente e usá-lo em geradores de código de cliente.

Schema de instrumento financeiro. O JSON Schema completo do corpo da requisição Adicionar um instrumento financeiro, novamente incluindo campos opcionais, com o objeto do payment rail (como usAch, euSepa ou brPix) e os metadados que descrevem os corredores de moeda compatíveis. Clique em Baixar schema para salvar.