Validating or Retrieving a Payment Reason Code with Recommendation

Validating or Retrieving a Payment Reason Code

If you are trying to retrieve the payment purpose codes or validate a payment purpose code that your client has, then this call will allow you to perform both functions.

By entering a country code or bank tokens you will be able to retrieve the list of payment reason codes for a country.

By entering the payment reason code that a user has you will be able to validate the code and return the codes text description.

By just entering the country then we will return the list of codes with their text description.

The response will give the payment purpose codes and descriptions for the country if the field purposeCode is not completed.  If the field purposeCode is completed then we will validate the purpose code entered in that field.

URL Structure

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

Method

GET command, in “application/json” format

Request

The request will only require the user to enter a valid freeToken and branchToken from a validation call or a Token and ISO country code to retrieve the holiday.

FIELD NAMEDESCRIPTIONFORMATMANDATORY
tokenSecurity token retrieved with the account security call.Alphanumeric & Extended CharactersMandatory
freeTokenFree security token retrieved with a validation call.Alphanumeric & Extended CharactersMandatory
countryCodeISO Country Code2 alphaMandatory
purposeCodeThe purpose code that a user has entered for valdiationAlphanumeric & Extended CharactersOptional
bankToken Token that defined the bank branch from a validation call.AlphanumericOptional
ref Request referenceAlphanumericOptional
errorCommentText description of  errorAlphanumeric & Extended CharactersOptional

The options for requests are

Payment Purpose Code list retrieval for a country

If you require the holiday for a country then you can enter the following details in a request

FIELD NAMEDESCRIPTIONFORMATMANDATORY
tokenSecurity token retrieved with the account security call.Alphanumeric & Extended CharactersMandatory
countryCodeISO Country Code2 alphaMandatory
refRequest referenceAlphanumericOptional

Validating an existing payment purpose code

If your user has an existing payment purpose code and you want to validate the code is still correct and the description of it then you can use these fields in the request

FIELD NAMEDESCRIPTIONFORMATMANDATORY
tokenSecurity token retrieved with the account security call.Alphanumeric & Extended CharactersMandatory
purposeCodeThe purpose code that a user has entered for valdiationAlphanumeric & Extended CharactersMandatory
refRequest referenceAlphanumericOptional
errorCommentText description of errorAlphanumeric & Extended CharactersOptional

Requesting the codes and descriptions for an existing validation

If you’ve already validated the payment details then you can use the freeToken and the bankToken to retrieve the payment purpose codes.

FIELD NAMEDESCRIPTIONFORMATMANDATORY
freeTokenFree security token retrieved with a validation call.Alphanumeric & Extended CharactersMandatory
bankToken Token that defined the bank branch from a validation call.AlphanumericMandatory
ref Request referenceAlphanumericOptional
errorCommentText description of  errorAlphanumeric & Extended CharactersOptional



Response

The response will have the format below but can contain payment reason codes.

FieldSizeFormatValuesDescription
codeUse1alphaS, R, AWill this be used for the sender or the receiver of the money.  Sender, receiver or all
countryCode2alphaISO Country Code listThis will be the country that the code relates to
currencyCode256alphaISO Currency Code listThis will list the currency codes that the description is used for
payPurpCode10alpha numericThis will be the code that is validated against or retrieved
primaryDecOff256alpha numeric with spacesOfficial primary description of the payment purpose code
primaryDecClean72alpha numeric with spacesCleansed primary description of the payment purpose code
secondaryDecOff256alpha numeric with spacesOfficial secondary description of the payment purpose code
secondaryDecClean72alpha numeric with spacesCleansed secondary description of the payment purpose code
networkServicecode5alpha numericClearing network unique code
networkServicedesc72alpha numeric with spacesClearing network name
usageType1AlphaA, C, PAll, corporate or personal account type
mandOpt1alphaIs the code mandatory or optional by default
swiftFieldUsageMT2numericWhich SWIFT MT field should it be used in by default
mtFieldContents256alpha numeric with spaces Contents of the SWIFT field
swiftFieldUsageISO36alpha numericWhich SWIFT ISO field should it be used in by default
iSOFieldContents256alpha numeric with spaces Contents of the ISO field