Get Schema Information
The API schema outlines each scenario's necessary fields and validation rules. A payment scenario includes the beneficiary's entity type and country, bank country code, and the account currency.
GET /payments/beneficiaries/schema/{entity_type}/{country}/{currency}?entity_country={entity_country}
Body Parameters Request
Name
Type
Format / Values
Description
Required
object
Yes
currency
string
/^[A-Z]{3,3}$/
Account currency (3-letter ISO 4217 currency code).
Yes
country
string
/^[A-Z]{2,2}$/
Bank country code (2-letter ISO 3166-2 country code).
Yes
entity_country
string
/^[A-Z]{2,2}$/
Beneficiary country code (2-letter ISO 3166-2 country code).
entity_type
string
INDIVIDUAL / BUSINESS
The beneficiary's type.
Body Parameters Response
Name
Type
Format / Values
Description
currency
string
The 3 letter ISO coude this schema relates to
country
string
The 2 letter ISO account country code this schema relates to
entity_type
string
INDIVIDUAL / BUSINESS
The type of beneficiary this schema relates to
schema
object
The JSONSchema definition
Request Example
Get /payments/beneficiaries/schema/INDIVIDUAL/US/USDResponse Examples
{
"currency": "USD",
"country": "US",
"entity_type": "INDIVIDUAL",
"schema": {
"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"entity": {
"$ref": "#/definitions/entity"
},
"bank_details": {
"$ref": "#/definitions/bank_details"
}
},
"definitions": {
"bank_details": {
"type": "object",
"properties": {
"account_country": {
"$target": [
"bank.bank_details.account_country",
"legal.attributes.BankCountry"
],
"anyOf": [
{
"enum": [
"US"
],
"title": "United States"
}
],
"default": "US",
"pattern": "^[A-Z]{2}$",
"title": "Account Country",
"type": "string"
},
"account_name": {
"$target": [
"bank.bank_details.name",
"legal.attributes.BankAccountName",
"legal.attributes.FullName"
],
"$ui": {
"errorMessage": "Account name has to be from 1 to 70 letters",
"placeholder": "Enter the full name associated with the account"
},
"max_length": 70,
"minLength": 1,
"pattern": "^.{1,70}$",
"title": "Account Name",
"type": "string"
},
"account_number": {
"$target": [
"bank.bank_details.local.account_number",
"legal.attributes.BankAccountNumber"
],
"$ui": {
"errorMessage": "Account number has to be 1 or up to 26 digits or chars",
"placeholder": "Enter a valid account number"
},
"pattern": "^[0-9A-Za-z]{1,26}$",
"title": "Account Number",
"type": "string"
},
"bank_code": {
"$target": [
"bank.bank_details.local.bank_code",
"legal.attributes.BankCode"
],
"$ui": {
"errorMessage": "Bank\\ABA code has to be 9 digits only",
"placeholder": "Enter Bank\\ABA code"
},
"maxLength": 9,
"minLength": 1,
"pattern": "^[0-9]{9}$",
"title": "Bank\\ABA code",
"type": "string"
},
"bank_identifier_code": {
"$target": [
"bank.bank_details.bic"
],
"$ui": {
"errorMessage": "Enter according to the format AAAAUSBBYYY (A is chars only, US, B is chars or digits, Y is chars or digits(Optionally))",
"placeholder": "Enter a valid SWIFT\\BIC code"
},
"pattern": "^[A-Z]{4}US[A-Z0-9]{2}([A-Z0-9]{3})?$",
"title": "SWIFT\\BIC Code",
"type": "string"
},
"bank_name": {
"$target": [
"bank.bank_details.local.bank_name",
"legal.attributes.BankName"
],
"$ui": {
"errorMessage": "Bank name has to be from 1 to 70 letters",
"placeholder": "Enter a valid bank name"
},
"pattern": "^.{1,70}$",
"title": "Bank name",
"type": "string"
}
},
"required": [
"bank_name",
"account_country",
"account_number",
"account_name",
"bank_identifier_code"
]
},
"entity": {
"type": "object",
"properties": {
"address_city": {
"$target": [
"bank.bank_details.address.city",
"legal.attributes.AddressCity"
],
"$ui": {
"errorMessage": "City name has to be from 1 to 70 letters",
"placeholder": "Enter City name"
},
"pattern": "^.{1,70}$",
"title": "City",
"type": "string"
},
"address_country": {
"$target": [
"bank.bank_details.address.country",
"legal.attributes.AddressCountry",
"legal.attributes.CountryOfResidence"
],
"$ui": {
"errorMessage": "Country has to be selected",
"hide": true
},
"anyOf": [
{
"enum": [
"US"
],
"title": "United States"
}
],
"default": "US",
"pattern": "^[A-Z]{2}$",
"title": "Address Country",
"type": "string"
},
"address_country_subdivision": {
"$target": [
"bank.bank_details.address.country_subdivision",
"legal.attributes.AddressState"
],
"anyOf": [
{
"enum": [
"AL"
],
"title": "Alabama"
},
{
"enum": [
"AK"
],
"title": "Alaska"
},
{
"enum": [
"AS"
],
"title": "American Samoa"
},
{
"enum": [
"AZ"
],
"title": "Arizona"
},
{
"enum": [
"AR"
],
"title": "Arkansas"
},
{
"enum": [
"CA"
],
"title": "California"
},
{
"enum": [
"CO"
],
"title": "Colorado"
},
{
"enum": [
"CT"
],
"title": "Connecticut"
},
{
"enum": [
"DE"
],
"title": "Delaware"
},
{
"enum": [
"DC"
],
"title": "District of Columbia"
},
{
"enum": [
"FL"
],
"title": "Florida"
},
{
"enum": [
"GA"
],
"title": "Georgia"
},
{
"enum": [
"GU"
],
"title": "Guam"
},
{
"enum": [
"HI"
],
"title": "Hawaii"
},
{
"enum": [
"ID"
],
"title": "Idaho"
},
{
"enum": [
"IL"
],
"title": "Illinois"
},
{
"enum": [
"IN"
],
"title": "Indiana"
},
{
"enum": [
"IA"
],
"title": "Iowa"
},
{
"enum": [
"KS"
],
"title": "Kansas"
},
{
"enum": [
"KY"
],
"title": "Kentucky"
},
{
"enum": [
"LA"
],
"title": "Louisiana"
},
{
"enum": [
"ME"
],
"title": "Maine"
},
{
"enum": [
"MD"
],
"title": "Maryland"
},
{
"enum": [
"MA"
],
"title": "Massachusetts"
},
{
"enum": [
"MI"
],
"title": "Michigan"
},
{
"enum": [
"MN"
],
"title": "Minnesota"
},
{
"enum": [
"MS"
],
"title": "Mississippi"
},
{
"enum": [
"MO"
],
"title": "Missouri"
},
{
"enum": [
"MT"
],
"title": "Montana"
},
{
"enum": [
"NE"
],
"title": "Nebraska"
},
{
"enum": [
"NV"
],
"title": "Nevada"
},
{
"enum": [
"NH"
],
"title": "New Hampshire"
},
{
"enum": [
"NJ"
],
"title": "New Jersey"
},
{
"enum": [
"NM"
],
"title": "New Mexico"
},
{
"enum": [
"NY"
],
"title": "New York"
},
{
"enum": [
"NC"
],
"title": "North Carolina"
},
{
"enum": [
"ND"
],
"title": "North Dakota"
},
{
"enum": [
"MP"
],
"title": "Northern Mariana Islands"
},
{
"enum": [
"OH"
],
"title": "Ohio"
},
{
"enum": [
"OK"
],
"title": "Oklahoma"
},
{
"enum": [
"OR"
],
"title": "Oregon"
},
{
"enum": [
"PA"
],
"title": "Pennsylvania"
},
{
"enum": [
"PR"
],
"title": "Puerto Rico"
},
{
"enum": [
"RI"
],
"title": "Rhode Island"
},
{
"enum": [
"SC"
],
"title": "South Carolina"
},
{
"enum": [
"SD"
],
"title": "South Dakota"
},
{
"enum": [
"TN"
],
"title": "Tennessee"
},
{
"enum": [
"TX"
],
"title": "Texas"
},
{
"enum": [
"UM"
],
"title": "United States Minor Outlying Islands"
},
{
"enum": [
"UT"
],
"title": "Utah"
},
{
"enum": [
"VT"
],
"title": "Vermont"
},
{
"enum": [
"VI"
],
"title": "Virgin Islands, U.S."
},
{
"enum": [
"VA"
],
"title": "Virginia"
},
{
"enum": [
"WA"
],
"title": "Washington"
},
{
"enum": [
"WV"
],
"title": "West Virginia"
},
{
"enum": [
"WI"
],
"title": "Wisconsin"
},
{
"enum": [
"WY"
],
"title": "Wyoming"
}
],
"pattern": "^[A-Z]{2}$",
"title": "State/Province",
"type": "string"
},
"address_line_1": {
"$target": [
"bank.bank_details.address.address_line1",
"legal.attributes.AddressLine1"
],
"$ui": {
"errorMessage": "Address has to be from 1 to 70 letters",
"placeholder": "Enter Address Line 1"
},
"pattern": "^.{1,70}$",
"title": "Address Line 1",
"type": "string"
},
"address_line_2": {
"$target": [
"bank.bank_details.address.address_line2",
"legal.attributes.AddressLine2"
],
"$ui": {
"errorMessage": "Address has to be from 1 to 70 letters",
"placeholder": "Enter Address Line 2"
},
"pattern": "^.{1,70}$",
"title": "Address Line 2",
"type": "string"
},
"address_postal_code": {
"$target": [
"bank.bank_details.address.postal_code",
"legal.attributes.AddressPostCode"
],
"$ui": {
"errorMessage": "Postal code has to be 5 digits or 5 digits dash (-) 4 digits",
"placeholder": "Enter Postal code"
},
"pattern": "^[0-9]{5}(?:-[0-9]{4})?$",
"title": "Postal code",
"type": "string"
},
"date_of_birth": {
"$target": [
"legal.attributes.BirthDate",
"bank.tags.date_of_birth"
],
"$ui": {
"errorMessage": "Date Of Birth has to be YYYY-MM-DD",
"placeholder": "Enter according to the format YYYY-MM-DD"
},
"format": "date",
"pattern": "^(19|20|30)\\d{2}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"title": "Date Of Birth",
"type": "string"
},
"individual_first_name": {
"$target": [
"legal.attributes.FirstName",
"bank.tags.first_name"
],
"$ui": {
"errorMessage": "First name is a mandatory field",
"placeholder": "Enter First name"
},
"title": "First Name",
"type": "string"
},
"individual_last_name": {
"$target": [
"bank.tags.last_name",
"legal.attributes.LastName"
],
"$ui": {
"errorMessage": "Last name is a mandatory field",
"placeholder": "Enter Last name"
},
"title": "Last Name",
"type": "string"
}
},
"required": [
"individual_first_name",
"individual_last_name",
"address_line_1",
"address_country",
"address_city",
"address_country_subdivision",
"address_postal_code",
"date_of_birth"
]
}
},
"required": [
"entity",
"bank_details"
]
}
}{
"error": "bad_request",
"description": "Validation errors: \"\" at #/currency failed against #/properties/currency with \"Did not match pattern: ^[A-Z]{3,3}$\"",
"error_code": 400
}Last updated