Rules
Vitesse supports sending payments globally. Each country and payment method has specific formatting and data requirements.
For example, when sending a payment to the UK, you can provide either:
- A Sort Code and Account Number
- An IBAN and SWIFT code
To support these variations, Vitesse uses a configurable set of rules.
Route types
Each payment method is a route type, which determines the applicable rules and required fields.
The following route types are available:
- Bank Account (default)
- Electronic cheque (USD, US only)
- Postal cheque (USD, US only)
- BankGiro (Sweden)
- PlusGiro (Sweden)
- PIX (Brazil)
You must specify the route type in API calls and batch files. If omitted, the default is Bank Account.
How rules work
Rules define the required data for a payment based on:
- Route type
- Destination country
- Destination currency
Each rule defines:
- Field name
- Validation type
- Minimum and maximum length
- Requirement level:
Mandatory – You must provide the field.
Optional – You do not need to provide the field, but if you do, Vitesse validates the value.
Conditional – You must provide the field only when a specific validation condition applies. - Any conditions that affect when the rule applies
Conditional rules may support multiple valid combinations. For example, a payment may require either an Account Number and Sort Code or an IBAN and SWIFT code.
Validation types
Each field is assigned a validation type that defines the permitted format and characters.
- Alpha – A-Z and a-z only
- AlphaNumeric – Allows A-Z, a-z and 0-9 only
- ExtendedAlphaNumeric – Allows numbers, letters, and spaces
- Numeric – Allows 0-9 only
- Any – Allows all characters
- DateTime – Valid date/time format
- Email – Valid email address
View rules
MAS
In MAS, go to Money Out → Rules.
You can filter by:
- Country
- Currency
- Route type
API
You can retrieve the rules for a specific country, currency, and route type through the Rules API.
For more information, see Rules API.
Updated 26 days ago