Endpoint: https://api.validate.bankersalmanac.com/country-services
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/countryServices
Overview
This call will allow our customers to understand the fields that they require to build their user interface and to request the correct details for their clients, to know how the basic code sets and account numbers are formed.
The purpose is so when they display the fields to their clients, they:
- Offer valid options
- Perform basic checks on the data
- Ensure the customers collect all the data that they require for the payment message to process without any intervention
The searching can be done by country code and by currency code. We will return the table with all entries for the country. The response will be in 3 blocks:
- Country information
Information on the country, including currency and holiday information.
- Bank Code and Account Number information
Information on the clearing networks and what fields are required.
- Additional Information
Is additional information available and what are the additional data points that you are required to collect.
Endpoint inputs
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| currencyCode | ISO Currency Code | Alpha | ||
| countryCode | ISO Country Code | Alpha | ||
| clearingCode | Type of holiday requested | Alpha | ||
| ref | Reference | Alphanumeric | ||
| errorComment | E or S, if the field is set to E then you will be able to edit the error text in the self service hub | E or S | ||
| normalizeAccents |
Response modifications
| Field Name | Description | Format |
| countryInformation | The configured country information | Object |
| paymentNetworkList.countryInformation | ||
| sepaFlag | Flag indicating participation in the Single Euro Payments Area (SEPA) | Y or N |
| ibanFlag | Flag indicating usage of the International Bank Account Number (IBAN) system | M, N, or O |
| preferredNetworkFlag | Flag if this is the preferred payment network | Y or N |
| mandatoryFormatFlag | Flag if format is mandatory | Y or N |
| activeFlag | Flag to indicate if this payment network is active | Y or N |
| updatedPreferredFormat | The preferred format for this payment network configuration | Y or N |
| paymentNetworkList.additionalInformation | The configured additional information of the country | |
| fullRetailAddressFlag | Flag indicating if the full retail address is required | M, N, or O |
| fullRetailAddressType | Type of the full retail address | Search or Drop Down List |
| fullCorporateAddressType | Type of the full corporate address | Search or Drop Down List |
| paymentReasonCodePrimaryFlag | Flag indicating if the primary payment reason code is required | M, N, or O |
| paymentReasonCodePrimaryType | Type of the primary payment reason code | Search or Drop Down List |
| paymentReasonCodeSecondaryFlag | Flag indicating if the secondary payment reason code is required | M, N, or O |
| paymentReasonCodeSecondaryType | Type of the secondary payment reason code | Search or Drop Down List |
| registrationNumberFlag | Flag indicating if the registration number is required | M, N, or O |
| registrationNumberType | Type of the registration number | Search or Drop Down List |
| passportNumberType | Type of the passport number | Search or Drop Down List |
| employeeNumberFlag | Flag indicating if the employee number is required | M, N, or O |
| employeeNumberType | Type of the employee number | Search or Drop Down List |
| employeeNumberSample | Sample of the employee number | Alphanumeric & Special Characters |
| nationalityFlag | Flag indicating if the nationality is required | M, N, or O |
| nationalIDFlag | Flag indicating if the national ID is required | M, N, or O |
| nationalIDType | Type of the national ID | Search or Drop Down List |
| taxCodeFlag | Flag indicating if the tax code is required | M, N, or O |
| taxCodeType | Type of the tax code | Search or Drop Down List |
| telephoneNumberFlag | Flag indicating if the telephone number is required | M, N, or O |
| telephoneNumberType | Type of the telephone number | Search or Drop Down List |
| fullBenBankNameAndAddressFlag | Flag indicating if the full ben?(tocheck) bank and address is required | M, N, or O |
| fullBenBankNameAndAddressType | Type of the full bank and address | Search or Drop Down List |
| otherFlag | Flag indicating if other information is required | M, N, or O |
| otherType | Type of the other information | Search or Drop Down List |
| driversLicenseNumberFlag | Flag indicating if the driver’s license number is required | M, N, or O |
| driversLicenseNumberType | Type of the driver’s license number | Search or Drop Down List |
| socialSecurityNumberFlag | Flag indicating if the social security number is required | M, N, or O |
| socialSecurityNumberType | Type of the social security number | Search or Drop Down List |
| emailAddressFlag | Flag indicating if the email address is required | M, N, or O |
| emailAddressType | Type of the email address | Search or Drop Down List |
| activeFlag | Flag to indicate if this configuration is active | Y or N |
Response outcomes
To understand the responses, please refer to Swagger – https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/countryServices
| Field Name | Description | Format | ||
| countryCode | The two-letter alphabetic code represents the country. | Alpha | ||
| currencyCode | The three-letter alphabetic code represents the currency. | Alpha | ||
| clearingCode | Clearing network code | Alphanumeric | ||
| errorComment | Flag to enhance the resulting comment with the value from the managed error in Validate Self Service. | Single Character | ||
| status | Status of the response PASS, CAUTION, or FAIL | Alpha | ||
| comment | Description associated with the response “status” field | Alpha | ||
| enhancedStatus | Status of the response PASS, CAUTION, or FAIL | Alpha | ||
| statusCode | Code associated with the response “comment” field | Alpha | ||
| paymentNetworkList | ||||
| countryInformation | The configured country information | Object | ||
| paymentNetworkList.countryInformation | ||||
| paymentNetworkList | The two-letter alphabetic code represents the country. | Alpha | ||
| countryName | The name of the country | Alpha | ||
| officialStateName | The official name of the country | Alpha | ||
| sepaFlag | Flag indicating participation in the Single Euro Payments Area (SEPA) | Y or N | ||
| ibanFlag | Flag indicating usage of the International Bank Account Number (IBAN) system | M, N, O | ||
| paymentNetworkList.countryInformation.holidays | ||||
| date | Date of the holiday | Alphanumeric & Special Characters | ||
| title | Title or description of the holiday | Alpha | ||
| day | Day of the week on which the holiday falls | Alpha & Special Characters | ||
| bankCodeAndAccountNumberInformation | ||||
| countryServiceConfigId | The identifier for this country service configuration | Numeric | ||
| clearingNetworkCode | Code for the clearing network | Alphanumeric | ||
| clearingNetworkName | Name of the clearing network | Alpha | ||
| networkLimitCurrency | Currency for network limit | Alpha | ||
| networkLimit | Limit for the network | Numeric & Special Characters | ||
| preferredNetworkFlag | Flag if this is the preferred payment network | Y or N | ||
| mandatoryFormatFlag | Flag if format is mandatory | Y or N | ||
| currencyCode | Code of the currency | Alpha | ||
| currencyName | Name of the currency | Alpha | ||
| cutOffTime | The cut-off time for this payment network | Numeric & Special Characters | ||
| preferredChargeType | Preferred charge type for this payment network | “OUR”, “SHA”, “BEN”, “DEBT”, “CRED”, “SHAR”, or “SLEV” | ||
| availableChargeType | Available charge type for this payment network | “OUR/SHA/BEN/DEBT/CRED/SHAR/SLEV” | ||
| bankCode | Bank code | Numeric | ||
| bankCodeName | Name of the bank | Alpha | ||
| bankCodeLength | Length of the bank code | Numeric | ||
| bankCodeFormat | Format of the bank code | Alphanumeric & Special Characters | ||
| bankCodeSample | Example value of the bank code | Numeric | ||
| bankCodeDescription | Description of the bank code | Alphanumeric & Special Characters | ||
| accountNumberCode | Account number code | Numeric | ||
| accountNumberName | Name of the account number | Alpha | ||
| accountNumberLength | Length of the account number | Numeric | ||
| accountNumberFormat | Format of the account number | Alphanumeric & Special Characters | ||
| accountNumberSample | Example value of the account number | Numeric | ||
| accountNumberDescription | Description of the account number | Alphanumeric & Special Characters | ||
| cscBankInfoId | Identifier for the default configuration of this country services bank information | Numeric | ||
| customCSCBankInfoId | Identifier for the custom configuration of this country services bank information | Numeric | ||
| companyId | Company Id | Alphanumeric | ||
| groupId | Group Id | Numeric | ||
| branchCode | Branch Code | Alphanumeric | ||
| branchCodeDescription | Description of the branch code | Alphanumeric | ||
| optionalFields | Optional fields information | Alphanumeric | ||
| optionalFieldsDescription | Description of the optional fields | Alphanumeric | ||
| preferredNetworkFlagDefault | Default value for preferred network flag | Alpha | ||
| cutOffTimeDefault | Default value for cut-off time | Numeric & Special Characters | ||
| preferredChargeTypeDefault | Default value for preferred charge type | “OUR”, “SHA”, “BEN”, “DEBT”, “CRED”, “SHAR”, or “SLEV” | ||
| bankCodeDescriptionDefault | Default value for bank code description | Alphanumeric & Special Characters | ||
| accountNumberDescriptionDefault | Default value for account number description | Alphanumeric & Special Characters | ||
| branchCodeDescriptionDefault | Default value for branch code description | Alphanumeric & Special Characters | ||
| optionalFieldsDescriptionDefault | Default value for optional fields | Alphanumeric & Special Characters | ||
| activeFlag | Flag to indicate if this payment network is active | Y or N | ||
| dateModified | Date when this payment network configuration is modified | Numeric & Special Characters | ||
| modifiedBy | User ID who modified this payment network configuration | Alphanumeric & Special Characters | ||
| cutOffTimeInput | The cut-off time of this payment network configuration | Numeric & Special Characters | ||
| currentTab | The current tab in which the user is when modifying this payment network configuration | Alpha | ||
| updatedPreferredFormat | The preferred format for this payment network configuration | Y or N | ||
| ibanCountryCodeDescription | Description of IBAN country code | Alphanumeric & Special Characters | ||
| ibanCheckDigitDescription | Description of IBAN check digit | Alphanumeric & Special Characters | ||
| ibanCountryCode | IBAN country code | Alpha | ||
| ibanCheckDigit | IBAN check digit | Numeric | ||
| ibanCountryCodeDescriptionDefault | Default description for IBAN country code | Alphanumeric & Special Characters | ||
| ibanCheckDigitDescriptionDefault | Default description for IBAN check digit | Alphanumeric & Special Characters | ||
| paymentNetworkList.additionalInformation | The configured additional information of the country | |||
| fullRetailAddressFlag | Flag indicating if the full retail address is required | “M”, “N”, or “O” | ||
| fullRetailAddressType | Type of the full retail address | “Search” or “Drop Down List” | ||
| fullRetailAddress1Sample | Sample of the full retail address line 1 | Alphanumeric & Special Characters | ||
| fullRetailAddress2Sample | Sample of the full retail address line 2 | Alphanumeric & Special Characters | ||
| fullRetailAddress3Sample | Sample of the full retail address line 3 | Alphanumeric & Special Characters | ||
| fullRetailAddress4Sample | Sample of the full retail address line 4 | Alphanumeric & Special Characters | ||
| fullRetailAddressDescription | Description of the full retail address | Alphanumeric & Special Characters | ||
| fullRetailAddressFieldMT | The field for full retail address in MT | Alphanumeric & Special Characters | ||
| fullRetailAddressFieldMX | The field for full retail address in MX | Alphanumeric & Special Characters | ||
| fullCorporateAddressFlag | Flag indicating if full corporate address is required | “M”, “N”, or “O” | ||
| fullCorporateAddressType | Type of the full corporate address | “Search” or “Drop Down List” | ||
| fullCorporateAddress1Sample | Sample of the full corporate address line 1 | Alphanumeric & Special Characters | ||
| fullCorporateAddress2Sample | Sample of the full corporate address line 2 | Alphanumeric & Special Characters | ||
| fullCorporateAddress3Sample | Sample of the full corporate address line 3 | Alphanumeric & Special Characters | ||
| fullCorporateAddress4Sample | Sample of the full corporate address line 4 | Alphanumeric & Special Characters | ||
| fullCorporateAddressDescription | Description of the full corporate address | Alphanumeric & Special Characters | ||
| fullCorporateAddressFieldMT | The field for full corporate address in MT | Alphanumeric & Special Characters | ||
| fullCorporateAddressFieldMX | The field for full corporate address in MX | Alphanumeric & Special Characters | ||
| paymentReasonCodePrimaryFlag | Flag indicating if the primary payment reason code is required | “M”, “N”, or “O” | ||
| paymentReasonCodePrimaryType | Type of the primary payment reason code | “Search” or “Drop Down List” | ||
| paymentReasonCodePrimarySample | Sample of the primary payment reason code | Alphanumeric & Special Characters | ||
| paymentReasonCodePrimaryDescription | Description of the primary payment reason code | Alphanumeric & Special Characters | ||
| paymentReasonCodePrimaryFieldMT | The field for primary payment reason code in MT | Alphanumeric & Special Characters | ||
| paymentReasonCodePrimaryFieldMX | The field for primary payment reason code in MX | Alphanumeric & Special Characters | ||
| paymentReasonCodeSecondaryFlag | Flag indicating if the secondary payment reason code is required | “M”, “N”, or “O” | ||
| paymentReasonCodeSecondaryType | Type of the secondary payment reason code | “Search” or “Drop Down List” | ||
| paymentReasonCodeSecondarySample | Sample of the secondary payment reason code | Alphanumeric & Special Characters | ||
| paymentReasonCodeSecondaryDescription | Description of the secondary payment reason code | Alphanumeric & Special Characters | ||
| paymentReasonCodeSecondaryFieldMT | The field for secondary payment reason code in MT | Alphanumeric & Special Characters | ||
| paymentReasonCodeSecondaryFieldMX | The field for secondary payment reason code in MX | Alphanumeric & Special Characters | ||
| registrationNumberFlag | Flag indicating if the registration number is required | “M”, “N”, or “O” | ||
| registrationNumberType | Type of the registration number | “Search” or “Drop Down List” | ||
| registrationNumberSample | Sample of the registration number | Alphanumeric & Special Characters | ||
| registrationNumberDescription | Description of the registration number | Alphanumeric & Special Characters | ||
| registrationNumberFieldMT | The field for registration number in MT | Alphanumeric & Special Characters | ||
| registrationNumberFieldMX | The field for registration number in MX | Alphanumeric & Special Characters | ||
| passportNumberType | Type of the passport number | “Search” or “Drop Down List” | ||
| passportNumberSample | Sample of the passport number | Alphanumeric | ||
| passportNumberDescription | Description of the passport number | Alphanumeric & Special Characters | ||
| passportNumberFieldMT | The field for passport number in MT | Alphanumeric & Special Characters | ||
| passportNumberFieldMX | The field for passport number in MX | Alphanumeric & Special Characters | ||
| employeeNumberFlag | Flag indicating if the employee number is required | “M”, “N”, or “O” | ||
| employeeNumberType | Type of the employee number | “Search” or “Drop Down List” | ||
| employeeNumberSample | Sample of the employee number | Alphanumeric & Special Characters | ||
| employeeNumberDescription | Description of the employee number | Alphanumeric & Special Characters | ||
| employeeNumberFieldMT | The field for employee number in MT | Alphanumeric & Special Characters | ||
| employeeNumberFieldMX | The field for employee number in MX | Alphanumeric & Special Characters | ||
| nationalityFlag | Flag indicating if the nationality is required | “M”, “N”, or “O” | ||
| nationalityType | Type of the nationality | “Search” or “Drop Down List” | ||
| nationalitySample | Sample of the nationality | Alpha | ||
| nationalityDescription | Description of the nationality | Alpha & Special Characters | ||
| nationalityFieldMT | The field for nationality in MT | Alpha & Special Characters | ||
| nationalityFieldMX | The field for nationality in MX | Alpha & Special Characters | ||
| nationalIDFlag | Flag indicating if the national ID is required | “M”, “N”, or “O” | ||
| nationalIDType | Type of the national ID | “Search” or “Drop Down List” | ||
| nationalIDSample | Sample of the national ID | Alphanumeric & Special Characters | ||
| nationalIDDescription | Description of the national ID | Alphanumeric & Special Characters | ||
| nationalIDFieldMT | The field for national ID in MT | Alphanumeric & Special Characters | ||
| nationalIDFieldMX | The field for national ID in MX | Alphanumeric & Special Characters | ||
| taxCodeFlag | Flag indicating if the tax code is required | “M”, “N”, or “O” | ||
| taxCodeType | Type of the tax code | “Search” or “Drop Down List” | ||
| taxCodeSample | Sample of the tax code | Numeric & Special Characters | ||
| taxCodeDescription | Description of the tax code | Alphanumeric & Special Characters | ||
| taxCodeFieldMT | The field for tax code in MT | Alphanumeric & Special Characters | ||
| taxCodeFieldMX | The field for tax code in MX | Alphanumeric & Special Characters | ||
| telephoneNumberFlag | Flag indicating if the telephone number is required | “M”, “N”, or “O” | ||
| telephoneNumberType | Type of the telephone number | “Search” or “Drop Down List” | ||
| telephoneNumberSample | Sample of the telephone number | Numeric & Special Characters | ||
| telephoneNumberDescription | Description of the telephone number | Alphanumeric & Special Characters | ||
| telephoneNumberFieldMT | The field for telephone number in MT | Alphanumeric & Special Characters | ||
| telephoneNumberFieldMX | The field for telephone number in MX | Alphanumeric & Special Characters | ||
| fullBenBankNameAndAddressFlag | Flag indicating if the full ben?(tocheck) bank and address is required | “M”, “N”, or “O” | ||
| fullBenBankNameAndAddressType | Type of the full bank and address | “Search” or “Drop Down List” | ||
| fullBenBankNameAndAddressSample | Sample of the full bank and address | Alphanumeric & Special Characters | ||
| fullBenBankNameAndAddressDescription | Description of the full bank and address | Alphanumeric & Special Characters | ||
| fullBenBankNameAndAddressFieldMT | The field for full bank and address in MT | Alphanumeric & Special Characters | ||
| fullBenBankNameAndAddressFieldMX | The field for full bank and address in MX | Alphanumeric & Special Characters | ||
| otherFlag | Flag indicating if other information is required | “M”, “N”, or “O” | ||
| otherType | Type of the other information | “Search” or “Drop Down List” | ||
| otherSample | Sample of the other information | Alphanumeric & Special Characters | ||
| otherDescription | Description of the other information | Alphanumeric & Special Characters | ||
| otherFieldMT | The field for the other information in MT | Alphanumeric & Special Characters | ||
| otherFieldMX | The field for the other information in MX | Alphanumeric & Special Characters | ||
| driversLicenseNumberFlag | Flag indicating if the driver’s license number is required | “M”, “N”, or “O” | ||
| driversLicenseNumberType | Type of the driver’s license number | “Search” or “Drop Down List” | ||
| driversLicenseNumberSample | Sample of the driver’s license number | Alphanumeric & Special Characters | ||
| driversLicenseNumberDescription | Description of the driver’s license number | Alphanumeric & Special Characters | ||
| driversLicenseNumberFieldMT | The field for driver’s license number in MT | Alphanumeric & Special Characters | ||
| driversLicenseNumberFieldMX | The field for driver’s license number in MX | Alphanumeric & Special Characters | ||
| socialSecurityNumberFlag | Flag indicating if the social security number is required | “M”, “N”, or “O” | ||
| socialSecurityNumberType | Type of the social security number | “Search” or “Drop Down List” | ||
| socialSecurityNumberSample | Sample of the Social Security number | Alphanumeric & Special Characters | ||
| socialSecurityNumberDescription | Description of the Social Security number | Alphanumeric & Special Characters | ||
| socialSecurityNumberFieldMT | The field for social security number in MT | Alphanumeric & Special Characters | ||
| socialSecurityNumberFieldMX | The field for social security number in MX | Alphanumeric & Special Characters | ||
| emailAddressFlag | Flag indicating if the email address is required | “M”, “N”, or “O” | ||
| emailAddressType | Type of the email address | “Search” or “Drop Down List” | ||
| emailAddressSample | Sample of the email address | Alphanumeric & Special Characters | ||
| emailAddressDescription | Description of the email address | Alphanumeric & Special Characters | ||
| emailAddressFieldMT | The field for the email address in MT | Alphanumeric & Special Characters | ||
| emailAddressFieldMX | The field for the email address in MX | Alphanumeric & Special Characters | ||
| activeFlag | Flag to indicate if this configuration is active | Y or N | ||
| dateModified | Date when this additional information configuration is modified | Alphanumeric & Special Characters | ||
| modifiedBy | User ID who modified this additional information configuration | Alphanumeric & Special Characters |
Test Examples
“countryCode”: “US”,
“currencyCode”: “USD”,