{"templateId":"markdown","versions":[{"version":"v2026.04","label":"v2026.04","link":"/products/payments-direct-2/api-docs/integration-resources/payload-schema-utility","default":true,"active":true,"folderId":"eb16255d"},{"version":"v2026.03","label":"v2026.03","link":"/products/payments-direct-2/v2026.03/api-docs/integration-resources/payload-schema-utility","default":false,"active":false,"folderId":"eb16255d"},{"version":"v2025.11","label":"v2025.11","link":"/products/payments-direct-2/v2025.11/api-docs/integration-resources/payload-schema-utility","default":false,"active":false,"folderId":"eb16255d"}],"sharedDataIds":{"sidebar":"sidebar-products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["direct2CombinedDataRequirementsPicker"]},"type":"markdown"},"seo":{"title":"Payload Schema Utility","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"payload-schema-utility","__idx":0},"children":["Payload Schema Utility"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this interactive tool to generate the exact JSON schema for creating identity and financial instrument tokens for any supported corridor in ","Payments Direct","."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Field requirements vary by payment rail, beneficiary type, originator type, and use case. This utility filters the schema for your specific scenario, showing only the fields you need to send."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-use-the-utility","__idx":1},"children":["How to use the utility"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make selections in the order below. Each step narrows the schema to your scenario."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity type"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INDIVIDUAL"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payment role"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORIGINATOR"]}," (sender) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BENEFICIARY"]}," (receiver)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Financial instrument type"]}," — the payment rail, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US_ACH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EU_SEPA"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR_PIX"]},". This selection determines the conditional fields required for the identity."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-the-utility-returns","__idx":2},"children":["What the utility returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Requirements table."]}," A scannable, tabular view of every field for the selected scenario, marked Required or Optional, with length and pattern constraints. Use this for quick reference during integration."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identity schema."]}," The complete JSON Schema for the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments-direct-2/api-docs/developer-guides/create-and-manage-identities"},"children":["Create an identity"]}," request body. Conditional fields (such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registration"]},") are automatically promoted into the schema's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," list when they apply to the selected payment role and rail. Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Download Schema"]}," to save the JSON locally for use in client code generators."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Financial instrument schema."]}," The JSON Schema for the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments-direct-2/api-docs/developer-guides/create-and-manage-financial-instruments"},"children":["Add a financial instrument"]}," request body, including the payment rail object (such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usAch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["euSepa"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brPix"]},") and the metadata describing the supported currency corridors. Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Download Schema"]}," to save."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"enter-your-selections","__idx":3},"children":["Enter your selections"]},{"$$mdtype":"Tag","name":"Direct2CombinedDataRequirementsPicker","attributes":{},"children":[]}]},"headings":[{"value":"Payload Schema Utility","id":"payload-schema-utility","depth":1},{"value":"How to use the utility","id":"how-to-use-the-utility","depth":2},{"value":"What the utility returns","id":"what-the-utility-returns","depth":2},{"value":"Enter your selections","id":"enter-your-selections","depth":2}],"frontmatter":{"title":"Payload Schema Utility","description":"Generate the exact JSON schema for creating identity and financial instrument tokens in any supported corridor.","seo":{"title":"Payload Schema Utility"}},"lastModified":"2026-05-27T18:08:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-direct-2/api-docs/integration-resources/payload-schema-utility","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}