The basic flow is
- Request a security token
- Use token to validate bank details
- Use the bank token and free token to request additional data
The flow you’re looking to achieve is
1. Request a Token
Request a token, this will confirm that you have a valid account and subscription and return a time limited token. The token is time limited to 10 minutes, you can reuse the token during that period but will need to renew the token before it expires.
The token is a POST request and the documentation is below with a username and password.
2. Validate Bank Details
Use the token with the bank details to validate the sender and receivers details, these calls contain a number of optional data points but these will be useful for future use cases.
Receiver’s information
This call has more information in it including beneficiaries name and address. This will be expanded to include mobile, email and individual or corporate account flags which will help but currently it’s account details and name and address. Again look at the recommended fields as we normalize the data in those fields.
Sample
Sender’s and receiver’s information
This call has both the sender and receivers information in it and will have the clients name and address. This will be expanded to include mobile, email and individual or corporate account flags which will help but currently it’s account details and name and address. Again look at the recommended fields as we normalize the data in those fields.
3. Correspondent Details
You will use the core call is below to retrieve the correspondent details
We also have best routing calls and are updating our logic at the moment to give our clients more options and control over the best routing.
4. Additional Data and Services
We have also released a number of information calls that give you details like payment purpose codes, holiday and ISO data that you might need. These are free to use and can be found here
Local Language
We can provide the bank details back in the local language, this call can be found here
Additional calls that you can use
These data points are free of charge and will enable you to round out your customer experience
Creating User Interfaces
This call allows our clients to call back the country search requirements, its designed to allow assist our clients in building UIs with the correct fields and to ensure that they can perform basic validation on their UI data fields. It tells our clients what search formats are valid for the country, an overview of the formats, help text, and tells you additional data that is required.
Key Features of this call are
• Bank code and bank account formats to use to ensure your customer knows the format of the
account that your user must enter for a payment.
• Includes help and examples so the customer can easily see what the account format is like.
• Ability to configure to add data to meet your companies’ risk and compliance requirements
• Country requirements for 11 different data types with help and examples including :
o Payment purpose codes
o Addresses
o Tax codes
o Telephone numbers
o Country and Currency names
o Holiday information
• Ability to configure data fields in our self-service hub to meet your companies’ risk and compliance requirements
The details on this call are in the link below
Country and Currency Data
These calls give ISO country and currency codes and names for the ISO details. This is free to use.
Payment Reason Codes
We can both deliver the payment reason codes to you and validate the payment code through this call
Holiday Data
We deliver the holiday data and a calculator for t + date here and the documentation for this call is just being updated but it is both a calculator and a delivery mechanism for the holiday data for each country/currency.
Information on Clearing Networks
This is available here, and the networks are being documented individually.