This call will validate the clients bank and account number, the one call will validate many formats including
- Bank codes (domestic clearing codes and BICs),
- Bank codes and account number,
- BBANs (such as CLABE) and
We always recommend back what you should be using including recommending any corrections or the format required change required for the payment.
The call is very flexible so you can take the data that your client has, we understand that using our AI and give you back what you need.
The service also give you prompts for additional data is available and in some cases required for the payment.
The service will also return the details for the Branch and Head Office of the bank (these may be the same branch) and also the branch that you require (see input options). If you make no change from the default request then it will return the IBAN branch.
These include for each branch
- Domestic and International Codes
- SEPA Status
- Indicators of additional information that is available
GET command, in “application/json” format
The request fields that are optional will affect the output values but not the output field, other than by using the parameter page. If you enter the optional request field page and enter a number then your response will be paginated. The default number of branches for a paginated response is 10 but this can be varied by entering the request field pageSize and giving it a value other than 10.
Calls that deliver additional details on the bank can be made using the branchToken (this defines the branch) and the freeToken (this means you will not be charged for these additional detail calls). The additional detail that you can access are:
- Correspondent details- These will be required if you are making a non-domestic payment
- Additional requirements – This lists the payment purpose codes for the country
- Payment network membership – These are the details of the banks connection to payment networks for example CHAPS in the UK or FedWire in the US.
- Holidays – This gives you a list of working and non-working days.
- Contact details – If you wish to contact the bank or branch
The request parameters can be downloaded here Response components table if you use the request field page then this will modify the output and the output fields can be found here.
If the user requests pagination which has been introduced in call 1.0.1 and call 1.0.2. The additional fields that are returned with the paginated response are:
- page – indicates the current page number – default value is 1
- pageSize – indicates how many branches are there per page – default value is 10
- pageTotal – indicates the total number of pages the user can traverse per inquiry
Try testing using POSTMAN which is available as a Google Chrome App and can be found here POSTMAN REST Client you can create project which you can create using the WADL to create the project. Just enter a valid authentication token into the request below and you’re working.
The test data entered into this sample is
Country Code: GB
National Code: 309408
Account Number: 01638696