Search and Field Requirements

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. The purpose is so when they display the fields to their clients they can display

  1. Valid options for their clients
  2. Perform basic checks on the data
  3. To ensure the customers collect all the data that they require for the payment message to process without any intervention

The call will allow them to retrieve the call and to build the user interface and to know how the basic code sets and account numbers are formed and to give their users help on them.

What subscription will this use

For the user to access the API call we will require the user to have a valid validate subscription and request a valid token.

Input options

Country Code

The user will input the country code and will optionally be able to put in the currency code and the clearing network.

For V1 the user will only be able to use the country and currency code. Clearing network will only be available as a filtering field in the second version.

Searching by country

Input fields

Country Code                    Mandatory

Currency Code                  Optional

Clearing Network             Optional (v2 only)

Searching by currency Code

The user will be enter the currency code and we will return the options for that currency.

Input fields

Country Code                    Optional

Currency Code                  Mandatory

Clearing Network             Optional

The user will be able to enter the country code and/or currency code. The clearing code will not be usable and will be a future feature.

Each country will have multiple formats and these will be listed by

Currency and clearing network/channel

The user will enter the country code and we will return the table with all entries for the country. The response will be in 3 blocks

Country information

Information on the country, this will be information on the country including country and currency and holiday information.

Bank Code and Account Number information

Information on the clearing networks and what fields are required. Each response will contain multiple sections as we will include one for each

Additional Information

Is additional information available and what are the additional data points that you are required to collect. These are subject to change and we strongly advise that you use a true JSON handler so that and additions to this are handled seamlessly.

Endpoint

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

Request

 

FIELD NAME DESCRIPTION FORMAT MANDATORY or

OPTIONAL

countryCode ISO Country Code Alpha Mandatory
currencyCode ISO Currency Code Alphanumeric Optional
clearingNetwork Clearing network code Alphanumeric Optional
token Security token Alphanumeric & Extended Characters Mandatory

 

Example

https://apps.applyfinancial.co.uk/validate-api/rest/convert/5.0?countryCode=gb&currencyCode=&clearingNetwork=&token=ENTERTOKENHERE

Response Fields

 

Field Name Description Sample
“countryCode” ISO Country Code  CA
“currencyCode” ISO Currency Code  CAD
“clearingCode” Clearing Network Code For future use
“errorComment” Error Comment Type  E
“status” Error Status  PASS
“comment” Error Text
“enhancedStatus” N/A  null
“statusCode” Error Code  null
“paymentNetworkList” For future use
“countryInformation”
“countryCode” ISO Country Code  CA
“countryName” Country Name  Canada
“officialStateName” Official full country name  Canada
“sepaFlag” Is the country a SEPA Country  null
“ibanFlag” Is the country an IBAN Country  null
“holidays”
“date” Date of Holiday dd/mm/yy format  11/04/20
“title” Name of holiday or non-workign day  Weekend holiday
“day” Day name of non-working day  SATURDAY
“bankCodeAndAccountNumberInformation”
“countryServiceConfigId” Apply Financial Id  105
“clearingNetworkCode” Code for clearing network  null
“clearingNetworkName” Clearing network name  null
“networkLimitCurrency” Clearing network limit currency
“networkLimit” Network limit of payment size  0.0
“preferredNetworkFlag” Is this the preferrred clearing network  N
“mandatoryFormatFlag” Is this the mandatory format that the country/clearing network dictates  N
“currencyCode” Currency Code
“currencyName” Currency Name  null
“cutOffTime” Cut off time 24 hour clock  null
“preferredChargeType” Preferred charge type for network  OUR
“availableChargeType” Available charge type for network  OUR/SHA/BEN
“bankCode” Code for the bank code type for network
“bankCodeName” Bank code name
“bankCodeLength” Bank code maximum length  0
“bankCodeFormat” Bank code format
“bankCodeSample” Example of the code
“bankCodeDescription” Bank code client help text
“accountNumberCode” Bank account code
“accountNumberName” Bank account name  BBAN
“accountNumberLength” Bank account maximum length  20
“accountNumberFormat” Bank account format  |d20
“accountNumberSample” Bank account example  00000001019049170000
“accountNumberDescription” Bank account client help text  The BBAN for Canada can be up to 20 digits. An example of the BBAN is 00000001019049170000.
“additionalInformation”
“fullRetailAddressFlag” Retail client address required flag  N
“fullRetailAddressType” Retail client address type of field required to validate the data
“fullRetailAddressSample” Example of the address that is required
“fullRetailAddressSample” Example of the address that is required
“fullRetailAddressSample” Example of the address that is required
“fullRetailAddressSample” Example of the address that is required
“fullRetailAddressDescription” Retail address client help text
“fullRetailAddressMt” MT field for this data
“fullRetailAddressMx” MX field for this data
“fullCorporateAddressFlag” Corporate address required flag  N
“fullCorporateAddressType” Corporate address type of field required to validate the data
“fullCorporateAddressSample” Example of the address that is required
“fullCorporateAddressSample” Example of the address that is required
“fullCorporateAddressSample” Example of the address that is required
“fullCorporateAddressSample” Example of the address that is required
“fullCorporateAddressDescription” Corporate address client help text
“fullCorporateAddressMt” MT field for this data
“fullCorporateAddressMx” MX field for this data
“paymentReasonCodePrimaryFlag” Primary Payment Reason Code required flag  N
“paymentReasonCodePrimaryType” Type of Field required to validate the Primary Payment Reason Code
“paymentReasonCodePrimarySample” Example of the Primary Payment Reason that is required
“paymentReasonCodePrimaryDescription” Primary Payment Reason Code client help text
“paymentReasonCodePrimaryMt” MT field for this data  70
“paymentReasonCodePrimaryMx” MX field for this data
“paymentReasonCodeSecondaryFlag” Secondary Payment Reason Code required flag  N
“paymentReasonCodeSecondaryType” Secondary Payment Reason Code type of field required to validate the data
“paymentReasonCodeSecondarySample” Example of the Secondary Payment Reason Code
“paymentReasonCodeSecondaryDescription” Secondary Payment Reason Code client help text  N
“paymentReasonCodeSecondaryMt” MT field for this data
“paymentReasonCodeSecondaryMx” MX field for this data
“registrationNumberFlag” Registration Number required flag  N
“registrationNumberType” Registration Number type of field required to validate the data
“registrationNumberSample” Example of the that is required
“registrationNumberDescription” Registration Number client help text
“registrationNumberMt” MT field for this data
“registrationNumberMx” MX field for this data
“passportNumberFlag” Passport Number required flag  N
“passportNumberType” Passport Number type of field required to validate the data
“passportNumberSample” Example of the Passport Number  that is required
“passportNumberDescription” Passport Number client help text
“passportNumberMt” MT field for this data
“passportNumberMx” MX field for this data
“employeeNumberFlag” Employee Number required flag  N
“employeeNumberType” Employee Number type of field required to validate the data
“employeeNumberSample” Example of the Employee Number that is required
“employeeNumberDescription” Employee Number client help text
“employeeNumberMt” MT field for this data
“employeeNumberMx” MX field for this data
“nationalityFlag” Nationality Flag required flag  N
“nationalityType” Nationality Flag type of field required to validate the data
“nationalitySample” Example of the Nationality Flag that is required
“nationalityDescription” Nationality Flag client help text
“nationalityMt” MT field for this data  null
“nationalityMx” MX field for this data  null
“nationalIDFlag” National ID required flag  N
“nationalIDType” National ID type of field required to validate the data
“nationalIDSample” Example of the National ID that is required
“nationalIDDescription” National ID client help text
“nationalIDMt” MT field for this data
“nationalIDMx” MX field for this data
“taxCodeFlag” Tax Code required flag  N
“taxCodeType” Tax Code type of field required to validate the data
“taxCodeSample” Example of the Tax Code that is required
“taxCodeDescription” Tax Code client help text
“taxCodeMt” MT field for this data
“taxCodeMx” MX field for this data
“telephoneNumberFlag” Telephone Number required flag  N
“telephoneNumberType” Telephone Number type of field required to validate the data
“telephoneNumberSample” Example of the Telephone Number that is required
“telephoneNumberDescription” Telephone Number client help text
“telephoneNumberMt” MT field for this data
“telephoneNumberMx” MX field for this data
“fullBenBankNameAndAddressFlag” Full Beneficiary Bank Name and Address required flag  N
“fullBenBankNameAndAddressType” Full Beneficiary Bank Name and Address type of field required to validate the data
“fullBenBankNameAndAddressSample” Example of the Full Beneficiary Bank Name and Address that is required
“fullBenBankNameAndAddressDescription” Full Beneficiary Bank Name and Address client help text
“fullBenBankNameAndAddressMt” MT field for this data
“fullBenBankNameAndAddressMx” MX field for this data
“otherRequirementsAndNotesFlag” Other requirements and notes required flag  N
“otherRequirementsAndNotesType” Other requirements and notes type of field required to validate the data
“otherRequirementsAndNotesSample” Example of the Other requirements and notes that are required
“otherRequirementsAndNotesDescription” Other requirements and notes client help text
“otherRequirementsAndNotesMt” MT field for this data
“otherRequirementsAndNotesMx” MX field for this data