Endpoint: https://api.validate.bankersalmanac.com/routing/best

Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/bestRouting

Overview

As a user you want to retrieve the best match of standard settlement instructions for both the sending and receiving bank and only a single response for the sender and receiver.

This request allows the user to enter the details for an originator and a beneficiary by entering the details for the sender (originator) and the receiver (beneficiary) of the payment. This call will then perform a best matching and will then list just the sender and receiver SSIs for the payment. If the call cannot perform a “best match” then it will give you an error and the user is then expected to use call https://api.validate.bankersalmanac.com/ssi/payer-payee to list all the available SSIs and to use a manual process to choose.

When the request is made the token entered in the request will be checked against the user’s subscription to ensure that the user has enough remaining subscription to make the call and a subscription will be deducted if the request responds with a Pass or Caution in the status field.

Endpoint inputs

This call will need the details for the originator and the beneficiary. The service will look up the Standard Settlement Instructions held for the originator and beneficiary and list them. If the user wishes to override the account number held by the system, then then should enter the account number in the originAcct field for the originator.

Field Name	Description	Format	Mandatory or Optional	Default Value
originatorBic	BIC of the originator	Alphanumeric	Mandatory
beneficiaryBic	BIC of the benefeciary	Alphanumeric	Mandatory
currency	ISO 3 digit currency code	Alpha	Mandatory
assetCategory			Optional

Response modifications

No modification can be done to the response.

Response outcomes

To understand the responses, please refer to Swagger – https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/bestRouting

Field Name	Description	Format
status	Status of the response PASS, CAUTION or FAIL	Alpha
comment	Description of the status	Alpha
currency	ISO 3 digit currency code	Alpha
routes	List of routes
routes.banks
bic	BIC of the bank	Alphanumeric
routes.banks.name
full	Full name of the bank	Alpha
short	Short name of the bank	Alpha
routes.banks.address
streetLine1	Line 1 street address of bank	Alphanumeric
streetLine2	Line 2 street address of bank	Alphanumeric
city	City address of bank	Alpha
routes.banks.address.state
full	Full state name address	Alphanumeric
short	Short state name address	Alphanumeric
routes.banks.address
postalCode	Postal code	Numeric
routes.banks.address.country
code	Country code of bank	Alpha
name	Country name	Alpha

 Test Examples

originator BIC AKBKTRISXXX

beneficiary BIC SMBCUS33

currency JPY