This call is designed to return the correspondent bank details for both payer (originator) and payee (beneficiary) required to make a payment. 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 the correspondent details for the currency that the user entered.
Field Name | Description | Format | Mandatory or Optional |
originBIC | BIC of the origin/ payer | Alphanumeric | Mandatory |
originAcct | Acct of the origin/ payer | Alphanumeric | Optional |
countryCode | ISO Country Code of beneficiary | Alpha | Mandatory |
currencyCode | ISO currency code of the payment | Alpha | Mandatory |
assetCategory | Asset category of the payment | Alphanumeric | Mandatory |
nationalId | Domestic bank ID or BIC of beneficiary | Alphanumeric | Mandatory |
benAcct | BIC of the Beneficiary | Alphanumeric | Optional |
token | Security token | Alphanumeric & Extended Characters | Mandatory |
The response for this request can be modified with a number of flags which allow us to give you a response which meets your business requirements.
Field Name | Description | Format | Default Value |
bic8 | Yes/No flag if you wish any head office with XXX to be returned as a BIC8 or BIC11 | Y or N | N |
Iso20022 | Input “Y” if you wish the response to return Legal Entity Identifier data and bank addresses to be returned in both ISO 20022 structured format and non-ISO 20022 format. | Y/N | N |
ref | Free text unique reference | Alphanumeric & Extended Characters |
|
errorComment | 1-character flag to determine if the enhanced “comment” from VSS will be returned | Alpha |
|
- ISO20022 Structured Address will return right below all otherwise structures address, if the ISO20022 flag is enabled in the response input.
- ISO 20022 structured data is only available in New API, not Legacy API.
Field Name | Description | Format |
countryCode | ISO Country Code of beneficiary | Alpha |
nationalId | Domestic bank ID or BIC of beneficiary | Alphanumeric |
accountNumber | Domestic Account Number, BBAN or IBAN of beneficiary | Alphanumeric |
status | Status of the call (e.g. pass, caution or fail) | Alpha |
comment | Description of the status | Alphanumeric & Extended Characters |
currencyCode | ISO currency code of the payment | Alpha |
originator | ||
nm | Name of the originator/ payer | Alphanumeric & Extended Characters |
pstlAdr | Address of the originator/ payer | Alphanumeric & Extended Characters |
bic | Bic of the originator/ payer | Alphanumeric |
acct | Account number of the of the originator/ payer | Alphanumeric |
codeDetails | ||
codeName1 | Code set 1 name | Alphanumeric |
codeValue1 | Code set 1 value | Alphanumeric |
codeName2 | Code set 2 name | Alphanumeric |
codeValue2 | Code set 2 value | Alphanumeric |
codeName3 | Code set 3 name | Alphanumeric |
codeValue3 | Code set 3 value | Alphanumeric |
codeName4 | Code set 4 name | Alphanumeric |
codeValue4 | Code set 4 value | Alphanumeric |
iso20022StructuredAddress | ||
bankName | Bank Name | Alphanumeric |
branch | Branch Name | Alphanumeric |
addressTypeCD | Type of address (e.g., physical, mailing) | Alpha |
addressTypePrtryID | Type proprietary identifier | Alpha |
addressTypePrtryIssuer | Issuer of proprietary identifier | Alpha |
addressTypePrtrySchemeName | Schema name of proprietary identifier | Alpha |
department | Department name | Alphanumeric |
subDepartment | Sub-department name | Alphanumeric |
streetName | Name of street | Alphanumeric |
buildingNumber | Building number | Alphanumeric |
buildingName | Name of building | Alphanumeric |
floor | Floor number | Numeric |
postBox | Post box number | Alphanumeric |
room | Room number | Alphanumeric |
postCode | Postal code | Alphanumeric |
townName | Town or city name | Alpha |
townLocationName | Location name within town or city | Alpha |
districtName | District name | Alpha |
countrySubdivision | Subdivision of country (state, province, etc.) | Alpha |
iso2 | ||
addressLine1 | Address line 1 | Alphanumeric |
addressLine2 | Address line 2 | Alphanumeric |
addressLine3 | Address line 3 | Alphanumeric |
addressLine4 | Address line 4 | Alphanumeric |
addressLine5 | Address line 5 | Alphanumeric |
addressLine6 | Address line 6 | Alphanumeric |
addressLine7 | Address line 7 | Alphanumeric |
legalEntityIdentifier | ||
identifierType | Description of the identifier type system | Alpha |
identifierValue | Value of the identifier assigned by the identifier type | |
ssiDetails | ||
subCategory | Asset subcategory of the payment | Alphanumeric |
assetCategory | Asset category of the payment | ALL, COMMERCIAL, FINANCIAL |
corresBIC | BIC of the originator/payer’s correspondent | Alphanumeric |
corresAcct | Account number of the originator/payer’s correspondent | Alphanumeric |
preferred | Preferred flag | Y/N |
beneficiary | ||
nm | Name of the beneficiary | Alphanumeric & Extended Characters |
pstlAdr | Address of the beneficiary | Alphanumeric & Extended Characters |
nationalId | Domestic bank ID or BIC of beneficiary | Alphanumeric |
bic | BIC of the beneficiary | Alphanumeric |
acct | Acct of the beneficiary | Alphanumeric |
codeDetails | ||
codeName1 | Code set 1 name | Alphanumeric |
codeValue1 | Code set 1 value | Alphanumeric |
codeName2 | Code set 2 name | Alphanumeric |
codeValue2 | Code set 2 value | Alphanumeric |
codeName3 | Code set 3 name | Alphanumeric |
codeValue3 | Code set 3 value | Alphanumeric |
codeName4 | Code set 4 name | Alphanumeric |
codeValue4 | Code set 4 value | Alphanumeric |
iso20022StructuredAddress | ||
bankName | Bank Name | Alphanumeric |
branch | Branch Name | Alphanumeric |
addressTypeCD | Type of address (e.g., physical, mailing) | Alpha |
addressTypePrtryID | Type proprietary identifier | Alpha |
addressTypePrtryIssuer | Issuer of proprietary identifier | Alpha |
addressTypePrtrySchemeName | Schema name of proprietary identifier | Alpha |
department | Department name | Alphanumeric |
subDepartment | Sub-department name | Alphanumeric |
streetName | Name of street | Alphanumeric |
buildingNumber | Building number | Alphanumeric |
buildingName | Name of building | Alphanumeric |
floor | Floor number | Numeric |
postBox | Post box number | Alphanumeric |
room | Room number | Alphanumeric |
postCode | Postal code | Alphanumeric |
townName | Town or city name | Alpha |
townLocationName | Location name within town or city | Alpha |
districtName | District name | Alpha |
countrySubdivision | Subdivision of country (state, province, etc.) | Alpha |
iso2 | ||
addressLine1 | Address line 1 | Alphanumeric |
addressLine2 | Address line 2 | Alphanumeric |
addressLine3 | Address line 3 | Alphanumeric |
addressLine4 | Address line 4 | Alphanumeric |
addressLine5 | Address line 5 | Alphanumeric |
addressLine6 | Address line 6 | Alphanumeric |
addressLine7 | Address line 7 | Alphanumeric |
legalEntityIdentifier | ||
identifierType | Description of the identifier type system | Alpha |
identifierValue | Value of the identifier assigned by the identifier type | |
ssiDetails | ||
assetCategory | Asset category of the payment | Alpha |
corresBIC | BIC of the correspondent | Alphanumeric |
corresAcct | Account number of the correspondent | Alphanumeric |
intrmyBIC1 | BIC of the beneficiary’s correspondent intermediary bank | Alphanumeric |
intrmyAcct1 | Account number of the beneficiary’s correspondent intermediary bank | Alphanumeric |
intrmyBIC2 | BIC of the beneficiary’s correspondent intermediary bank | Alphanumeric |
intrmyAcct2 | Account number of the beneficiary’s correspondent intermediary bank | Alphanumeric |
institutionName | Name of the intitution | Alphanumeric |
city | City name | Alphanumeric |
countryName | Country name | Alphanumeric |
countryCode | Country code | Alphanumeric |
natId | National ID | Alphanumeric |
preferred | Preferred flag | Alpha |
recommendedAcct | Our recommended account number to make the payment | Alphanumeric |
recommendedBIC | Our recommended BIC to make the payment | Alphanumeric |
ref | Free text unique reference | Alphanumeric & Extended Characters |
bic8 | Yes/No flag if you wish any head office with xxx to be returned as a BIC8 or BIC11 | Y or N |
Iso20022 | Returns the input “Y” if you wished the response to return Legal Entity Identifier data and addresses to be returned in both ISO 20022 structured format and non-ISO 20022 format. | Y or N |
originBIC: BARCGB22
currencyCode: GBP
assetCategory: ALL
countryCode: IN
nationalID: SBIN0004650
iso20022: Y
{
“countryCode”: “IN”,
“nationalId”: “SBIN0004650”,
“accountNumber”: null,
“status”: “PASS”,
“comment”: “”,
“currencyCode”: “GBP”,
“originator”: {
“nm”: “Barclays Bank PLC”,
“pstlAdr”: “1 Churchill Place, London, E14 5HP, UNITED KINGDOM”,
“bic”: “BARCGB22XXX”,
“acct”: “”,
“codeDetails”: {
“codeName1”: “BIC”,
“codeValue1”: “BARCGB22XXX”,
“codeName2”: “CHIPS”,
“codeValue2”: “313564”,
“codeName3”: “BIC-4”,
“codeValue3”: “BARC”,
“codeName4”: “Sort Code”,
“codeValue4”: “206874”
},
“iso20022StructuredAddress”: {
“bankName”: “Barclays Bank PLC”,
“branch”: “”,
“addressTypeCD”: “”,
“addressTypePrtryID”: “”,
“addressTypePrtryIssuer”: “physical”,
“addressTypePrtrySchemeName”: “”,
“department”: “”,
“subDepartment”: “”,
“streetName”: “Churchill Place”,
“buildingNumber”: “1”,
“buildingName”: “”,
“floor”: “”,
“postBox”: “”,
“room”: “”,
“postCode”: “E14 5HP”,
“townName”: “London”,
“townLocationName”: “”,
“districtName”: “Greater London”,
“countrySubdivision”: “England”,
“iso2”: “GB”,
“addressLine1”: “”,
“addressLine2”: “”,
“addressLine3”: “”,
“addressLine4”: “”,
“addressLine5”: “”,
“addressLine6”: “”,
“addressLine7”: “”
},
“legalEntityIdentifier”: {
“identifierType”: “London Stock Exchange LEI Limited (London Stock Exchange) (IEI)”,
“identifierValue”: “G5GSEF7VJP5I7OUK5573”
},
“ssiDetails”: [
{
“assetCategory”: “COMMERCIAL”,
“corresBIC”: “BARCGB22XXX”,
“corresAcct”: null,
“preferred”: “N”,
“subCategory”: “CMP”
}
]
},
“beneficiary”: {
“nm”: “State Bank of India”,
“pstlAdr”: “Rahul Apt., S.V. Rd, Andheri(West), Mumbai, 400058, INDIA”,
“nationalId”: “SBIN0004650”,
“bic”: “”,
“acct”: “”,
“codeDetails”: {
“codeName1”: “BIC”,
“codeValue1”: “”,
“codeName2”: “CHIPS”,
“codeValue2”: “”,
“codeName3”: “BIC-4”,
“codeValue3”: “”,
“codeName4”: “IFSC”,
“codeValue4”: “SBIN0004650”
},
“iso20022StructuredAddress”: {
“bankName”: “State Bank of India”,
“branch”: “Andheri West Branch”,
“addressTypeCD”: “”,
“addressTypePrtryID”: “”,
“addressTypePrtryIssuer”: “physical”,
“addressTypePrtrySchemeName”: “”,
“department”: “”,
“subDepartment”: “”,
“streetName”: “S.V. Road”,
“buildingNumber”: “”,
“buildingName”: “”,
“floor”: “”,
“postBox”: “”,
“room”: “”,
“postCode”: “400058”,
“townName”: “Mumbai”,
“townLocationName”: “”,
“districtName”: “”,
“countrySubdivision”: “Maharashtra”,
“iso2”: “IN”,
“addressLine1”: “Rahul Apt.”,
“addressLine2”: “Andheri(West)”,
“addressLine3”: “”,
“addressLine4”: “”,
“addressLine5”: “”,
“addressLine6”: “”,
“addressLine7”: “”
},
“legalEntityIdentifier”: {
“identifierType”: “The Global Markets Entity Identifier (GMEI)”,
“identifierValue”: “5493001JZ37UBBZF6L49”
},
“ssiDetails”: [
{
“assetCategory”: “FINANCIAL”,
“corresBIC”: “SBINGB2LXXX”,
“corresAcct”: “96268056”,
“intrmyBIC1”: null,
“intrmyAcct1”: null,
“intrmyBIC2”: null,
“intrmyAcct2”: null,
“institutionName”: “State Bank of India”,
“city”: “London”,
“countryName”: “UNITED KINGDOM”,
“countryCode”: “GB”,
“natId”: “608365”,
“preferred”: “N”,
“subCategory”: “DER”
},
{
“assetCategory”: “FINANCIAL”,
“corresBIC”: “SBINGB2LXXX”,
“corresAcct”: “96268056”,
“intrmyBIC1”: null,
“intrmyAcct1”: null,
“intrmyBIC2”: null,
“intrmyAcct2”: null,
“institutionName”: “State Bank of India”,
“city”: “London”,
“countryName”: “UNITED KINGDOM”,
“countryCode”: “GB”,
“natId”: “608365”,
“preferred”: “N”,
“subCategory”: “MYM”
}
]
},
“recommendedAcct”: “”,
“recommendedBIC”: “SBININBBXXX”,
“ref”: “20241107151321923”,
“bic8”: “N”,
“iso20022”: “Y”
}