Payload Schema Utility

Use this interactive tool to generate the exact JSON schema for creating identity and financial instrument tokens for any supported corridor in Payments Direct.

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.

Make selections in the order below. Each step narrows the schema to your scenario.

1. Identity type — INDIVIDUAL or BUSINESS.
2. Payment role — ORIGINATOR (sender) or BENEFICIARY (receiver).
3. Financial instrument type — the payment rail, such as US_ACH, EU_SEPA, or BR_PIX. This selection determines the conditional fields required for the identity.

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.

Identity schema. The complete JSON Schema for the Create an identity request body. Conditional fields (such as dateOfBirth or registration) are automatically promoted into the schema's required list when they apply to the selected payment role and rail. Click Download Schema to save the JSON locally for use in client code generators.

Financial instrument schema. The JSON Schema for the Add a financial instrument request body, including the payment rail object (such as usAch, euSepa, or brPix) and the metadata describing the supported currency corridors. Click Download Schema to save.