Beneficiary Correspondent Details

This call is designed to return the correspondent bank details required to make a payment for the payment details entered. This call does not return any details on the branch itself.  The call will validate the clients account number and bank code data and respond with only the correspondent details for the currency that the user entered.  The search criteria as below and also require the user to enter a valid ISO currency code.

  1. National id
  2. BIC
  3. National id and domestic account number
  4. BIC and domestic account number
  5. Structured account number (BBAN, IBAN or CLABE).

The service returns a recommended account number and national id and BIC and any correspondents for the chosen currency.  The service will also return the details for the Branch and additional branch (these may be the same branch) and can be specified in the request parameters.

METHOD

GET command, in “application/json” format

https://apps.applyfinancial.co.uk/validate-api/rest/convert/2.2

REQUEST

The call description is

FIELD NAME DESCRIPTION FORMAT MANDATORY or OPTIONAL DEFAULT VALUE TYPE
countryCode ISO Country Code Alpha Mandatory String
nationalId Domestic bank ID Alphanumeric Optional String
accountNumber Domestic Account Number, BBAN or IBAN Alphanumeric Optional String
currencyCode ISO currency code of the payment Alpha Mandatory String
dataStore Yes/No flag if you wish the data to be stored and scanned by us Y or N Optional N String
ref Free text unique reference Alphanumeric & Extended Characters Optional String
token Security token Alphanumeric & Extended Characters Optional String
bic8 Yes/No flag if you wish any head office with xxx to be returned as a BIC8 or BIC11 Y or N Optional N String
payBranchType This allows you to choose the branch type from either
IBAN
Routing
Payment
Branch
Head Office
I,B,H,R Optional I String
group Unique group to group a series of refs together Alphanumeric & Extended Characters Optional String

 

RESPONSE

The request parameters are below, the SSI details can be repeated if the institution has multiple correspondents per currency.

Field name Description Format Type Example
countryCode ISO Country Code Alpha String GB
currencyCode ISO currency code Alpha String USD
nationalId Domestic National ID Alphanumeric String 309408
accountNumber Domestic Account Number, BBAN or IBAN Alphanumeric String 01638696
status Status of the call (e.g. pass, caution or fail) Alpha String PASS
comment Alphanumeric & Extended Characters String
ssiDetails Field Label
assetCategory Asset category of the payment ALL, COMMERCIAL, FINANCIAL COMMERCIAL
corresBIC BIC of the correspondent IRVTUS3NXXX
corresAcct Account number of the correspondent account
intrmyBIC1 BIC of the correspondents intermediary bank
intrmyAcct1 Account number of the correspondent intermediary bank
intrmyBIC2 BIC of the correspondents intermediary bank
intrmyAcct2 Account number of the correspondent account intermediary bank

TEST

Try testing using POSTMAN which is available as a Google Chrome App and can be found below.  Just enter a valid authentication token and you’re working.  The test data entered into this sample is

Country Code: GB
National Code: 309408
Account Number: 01638696
Currency Code: USD

https://apps.applyfinancial.co.uk/validate-api/rest/convert/2.2?countryCode=gb&nationalId=309408&accountNumber=01638696&token=ENTERTOKENHERE&noBranch=N&errorComment=E&currencyCode=USD