Get validation schema for international recipients

GET /recipients/validation-schema
Bearer auth

Retrieve the JSON schema for validating international recipient data based on country, currency, and payout method

Query parameters

  • countryCode string Required

    Destination country code (ISO 3166-1 alpha-2)

  • currencyCode string Required

    Destination currency code (ISO 4217)

  • payoutMethod string Required

    Payout method (e.g., LOCAL, SWIFT)

    Values are LOCAL or SWIFT.

Responses

  • 200 application/json

    Array of validation schemas

    Hide response attributes Show response attributes object
    • $id string

      Schema identifier

    • $schema string

      JSON Schema version URI

    • allOf

      Combined validation rules (allOf)

    • anyOf

      Conditional validation rules (anyOf)

    • properties object Required

      Map of property names to their validation rules

      Hide properties attribute Show properties attribute object
      • * object Additional properties

        Property definition within a validation schema

        Hide * attributes Show * attributes object
        • $id string

          Property identifier

        • const string

          Constant value

        • enum array[string]

          Allowed values for enum types

        • errorMessage string

          Error message for validation failures

        • maxLength string

          Maximum length constraint

        • pattern string

          Regex pattern for validation

        • title string

          Human-readable property title

        • type string Required

          Property type (string, number, etc.)

    • required array[string]

      List of required field names

    • title string

      Schema title

    • type string Required

      Schema type (typically 'object')
  • 400 application/json

    Invalid parameters

    Hide response attributes Show response attributes object
    • errorCode string Required

      Error code

    • message string Required

      Error message
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • errorCode string Required

      Error code

    • message string Required

      Error message
GET /recipients/validation-schema 
curl \
 --request GET 'https://bank.bank.place/recipients/validation-schema?countryCode=VN&currencyCode=VND&payoutMethod=LOCAL' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "$id": "string",
    "$schema": "string",
    "properties": {
      "additionalProperty1": {
        "$id": "string",
        "const": "string",
        "enum": [
          "string"
        ],
        "errorMessage": "string",
        "maxLength": "string",
        "pattern": "string",
        "title": "string",
        "type": "string"
      },
      "additionalProperty2": {
        "$id": "string",
        "const": "string",
        "enum": [
          "string"
        ],
        "errorMessage": "string",
        "maxLength": "string",
        "pattern": "string",
        "title": "string",
        "type": "string"
      }
    },
    "required": [
      "string"
    ],
    "title": "string",
    "type": "string"
  }
]
Response examples (400) 
{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}
Response examples (401) 
{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}