The Rule data type defines how the AccountDescriptor and any extra fields are validated based on the recipient's country and currency. In addition to basic checks like length and mandatory requirements, it can also include special rules such as Allowlist or Denylist.

Property	Type	Description
ConditionCode	String	Conditional validation code, see below.
Field	String	Field id. Since Rule may represent both system and additional validation rules, this property is nullable. This is because custom rules may be defined for Extra fields identified by Path (request.Extra.*) and custom FieldName, rather than system Field.
FieldName	String	Field display name.
FieldType	String	Represents the type of data contained within the field. See the list of possible types below.
MaximumLength	Number	Maximum length of field in characters. If more than one rule applies for the same field, the more restrictive length will be chosen.
MinimumLength	Number	Minimum length of field in characters. If more than one rule applies for the same field, the more restrictive length will be chosen.
Options	String	Describes the optionality of a field. See the list of possible values below. If more than one rule applies for the same field, the more restrictive value will be chosen.
Path	String	Indicates the location within a TransactionRequest of the field, see below.
Conditions	Array of RuleCondition	Contains special conditions, like Allowlist, Denylist, BlendLookup with parameters.

{
  "Field": "ExternalReference1",
  "FieldName": "External Reference 1",
  "FieldType": "AlphaNumeric",
  "MaximumLength": 128,
  "MinimumLength": 0,
  "Options": "Mandatory",
  "Path": "request.ExternalReference1",
  "Conditions": [
      {
        "ConditionType": "Allowlist",
        "Parameters": {
          "Choices": [
            "val1",
            "val2"
          ],
          "Descriptions": [
            "Value 1",
            "Value 2",
          ],
          "PermitFreeformEntry": false
        }
      }
    ]

}

FieldType

The FieldType field represents the type of data contained within the field. The list of supported FieldTypes is as follows:

Type	Field Type Description
AlphaNumeric	Numbers and letters only.
Numeric	Numbers only.
ExtendedAlphaNumeric	Numbers, letters and spaces only.
Email	Email address.
Alpha	Alphabetic characters only.
Any	Any characters are permitted.
DateTime	Dates are permitted.

Options

The Options field may contain:

Mandatory – The field must always be provided.
Optional – The field is not required but will be checked if provided.
Conditional – The field is needed only under certain conditions, based on a ConditionCode.

Path

The Path field indicates the location within a TransactionRequest object that this particular property should appear. This path can be used to help build a valid TransactionRequest for a given country and currency combination.

For example the path “request.Recipient.Account.PaymentPurpose” indicates that the PaymentPurpose property should be supplied within a TransactionRequest in the following structure:

{
  // ...
  "Recipient": {
    // ...
    "Account": {
       // ...
      "PaymentPurpose": "YOUR PAYMENT PURPOSE"
    }
  }
}

ConditionCode

Rules can optionally have a field named ConditionCode. This describes the field-specific conditions that must apply to a TransactionRequest.

List of Rules

Code	Rule Description
X01	Amount field must be between 10 and 45000 RMB.
X02	Either an IBAN and Swift code, or a branch code and an account number must be provided.
X03	Either an IBAN and Swift code, or a sort code and an account number, must be provided.
X04	BankAccountType must be either 0 (checking account/cuenta corriente) or 1 (savings/ahorro).
X05	BankAccountType must be either PC (personal checking) or PS (personal saving).
X06	Either NUBAN, or an account number, must be provided.
X07	Either IBAN, or account number, must be provided.
X08	If the Swift code is 8 characters long, then the BankAddress field is required.
X09	This rule is not yet enforced. When sending payments to Russia, this rule indicates that the recipient name and address should include Cyrillic characters.
X10	This rule is not yet enforced. If the TaxId is 10 characters long then the KppCode must be provided and must be 9 characters long.
X11	This rule applies to non-domestic routes where the currency is not the domestic currency (e.g. sending EUR to the UK, or USD to Germany). You can specify either the IBAN or the Account Number fields to identify the account. Some other fields defined by this rule are mandatory. In addition, the Recipient Address is mandatory, unless the payment recipient currency is EUR and their country is one of Bulgaria, Croatia, Czechia, Denmark, Hungary, Poland, Romania, Sweden, Iceland, Liechtenstein, Norway, Switzerland, UK, in which case the address is optional.
X12	Either an IBAN, or a branch code and an account number must be provided.
X13	Provide one Bank Account Type : '0' for Checking (Cuenta Corriente), '1' for Savings (Ahorro). When sending payments to Brazil, certain banks require specific lengths and prefixes for the AccountNumber (cf. X13 Brazil Account Number Validations below).
X14	When sending payments to the United States with US currency, either an ABA code that is ACH capable must be provided, or else both the ABA code and the Swift code must be provided. This rule also mandates that, although a bank account type is optional, if it is provided, then it must be one of the values 'Checking' or 'Savings'.
X15	When processing Swedish BankGiro or PlusGiro payments please ensure you provide either a Recipient Reference or an OCR Reference Number, but not both.
X16	When processing Norwegian BankAccounts payments please ensure you provide either a Recipient Reference or a KID Reference Number, but not both. As well as either an IBAN or an AccountNumber and BranchCode.
X17	Either a TaxId, ResidenceNumber or RegistrationNumber must be provided.
X18	When processing Korean Bank Account payments please ensure you provide a Residence Number (a.k.a Resident Registration Number or RRN) when making a payment to an Individual beneficiary. When making a payment to a corporate beneficiary, you must provide a Business Registration Number. Only provide either a Residence Number or a Business Registration Number. -- Please note that starting 30 June 2025, sending KRW to South Korea will no longer using rule X18; instead, it must use rule X26.
X19	Require a Branch Code which is used to look up a list of bank branches that are reachable through the local settlement system. If the branch code is on this supported list, then the SWIFT code is optional, however if the branch code is not on the supported list, then we will also require a SWIFT code.
X20	When destination currency is BRL and RouteType is PIX: Tax ID is mandatory. Select one Account Type only from PixPhoneNumber, EmailAddress, PixAccountNumber, or PixTaxId. The beneficiary field required depends on the selected Account Type. Only the beneficiary field corresponding to the selected Account Type should contain a value. No other PIX key values may be provided.
X21	Provide one Bank Account Type : '0' for Checking (Cuenta Corriente), '1' for Savings (Ahorro), and provide one Beneficiary's ID; National ID, Foreign ID, or Tax ID.
X22	Provide one Bank Account Type: '0' for Checking (Cuenta Corriente), '1' for Savings (Ahorro), '3' for Vista Account
X23	Provide one Beneficiary's ID: National ID, Foreign ID, or Tax ID.
X24	Provide one Bank Account Type : '0' for Checking (Cuenta Corriente), '1' for Savings (Ahorro), and provide one Beneficiary's ID; National ID, or Tax ID.
X25	Provide only 1 Beneficiary's ID from 2 options; a National ID or a Tax ID.
X26	When processing Korean Bank Account payments please ensure you provide a Residence Number (a.k.a Resident Registration Number or RRN) when making a payment to an Individual beneficiary and when making a payment to a Corporate beneficiary, please provide a Business Registration Number. Please only provide only one of these identifiers, either a Residence Number or a Business Registration Number. Additionally, the beneficiary’s phone number is mandatory and must include the country code without any leading “+”, “00” or “0”. Although the country code does not have to be South Korean, the phone number must be capable of receiving SMS verification. For example: 821012345678 82 = beneficiary_contact_country_code -- 2 characters -- under 5 chars✔ 1012345678 = beneficiary_contact_number -- 10 characters -- under 17 chars✔ Another example: 447378971449 44 = beneficiary_contact_country_code -- 2 characters -- under 5 chars✔ 7378971449 = beneficiary_contact_number -- 10 characters -- under 17 chars✔

X13 Brazil Account Number Validations

Branch Agency Code	Bank Name	Bank Account Type	Min. Length	Max. Length	Prefixes	Notes
001	Banco do Brasil S.A.	0	8	9
001	Banco do Brasil S.A.	1	9	10	00, 01, 51, 02, 52, 91, 92, 96, 97
033	Banco Santander Brasil S.A.	0	9	9	01, 02, 03, 05, 09, 13, 92
033	Banco Santander Brasil S.A.	1	9	9	60
104	Caixa Economica Federal - CEF	0	8	9		We will accept either 8, 9, 11 or 12 digits. If 11-12 digits please ensure a valid prefix is present.
104	Caixa Economica Federal - CEF	0	11	12	001, 010, 003, 023	We will accept either 8, 9, 11 or 12 digits. If 11-12 digits please ensure a valid prefix is present.
104	Caixa Economica Federal - CEF	1	8	9		We will accept either 8, 9, 11 or 12 digits. If 11-12 digits please ensure a valid prefix is present.
104	Caixa Economica Federal - CEF	1	11	12	013, 022	We will accept either 8, 9, 11 or 12 digits. If 11-12 digits please ensure a valid prefix is present.
237	Banco Bradesco S.A.	0	7	8
237	Banco Bradesco S.A.	1	7	8
341	Itau Unibanco S.A.	0	6	6
341	Itau Unibanco S.A.	1	6	6
399	HSBC Bank Brasil S.A.	0	7	7
399	HSBC Bank Brasil S.A.	1	7	7