Endpoint: https://api.validate.bankersalmanac.com/payer
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/payer
Overview
This call will enable you to validate the bank details.
If you are just validating a bank code or a BIC with an account number then just complete the country code, bank code, bank code field in the call. You can also validate:
- Individuals name
- Address details
- Charge type
- Transaction date
Endpoint inputs
These fields are the core fields that you will use. For the request listed above you only need complete the countryCode and nationalId fields. We have a number of optional fields which you can use to tailor the output and are listed below.
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| dtrSalName | Creditor salutation | Alpha | Alpha | |
| cdtrFirstName | Creditor First Name | Alpha | Alpha | |
| cdtrMiddleName | Creditor Middle Name | Alpha | Optional | |
| cdtrLastName | Creditor Last Name | Alpha | Optional | |
| cdtrAddr1 | Creditor Address Line 1 | Alphanumeric | Optional | |
| cdtrAddr2 | Creditor Address Line 2 | Alphanumeric | Optional | |
| cdtrCity | Creditor City | Alphanumeric | Optional | |
| cdtrRegion | Creditor Region | Alphanumeric | Optional | |
| cdtrZip | Creditor Zip code | Numeric | Optional | |
| cdtrCompanyName | Creditor Company Name | Alpha | Optional | |
| cdtrNatId | Creditor National ID / Sort Code / BIC | Alphanumeric | Mandatory | |
| cdtrAcct | Creditor Account Number / IBAN / BBAN | Alphanumeric | Mandatory | |
| cdtrCtryCde | Creditor ISO Country Code | Alpha | Mandatory | |
| currencyCode | Creditor ISO Currency Code | Alpha | ||
| accountType | Creditor Account Type | P or B | Optional | |
| chrg | Charge Type (SHA, OUR, BEN, SLEV, DEBT, CRED, SHAR) | Alpha | Optional | |
| pmtInfId | Payment Information ID, reference to be used for the payment | Alphanumeric | Optional | |
| trnsDt | Transaction Date (format: yyyy/MM/dd) | Alpha | Optional | |
| amt | amount | Numeric | Optional | |
| strict | Strict flag (If the flag is set to Y then they will warned if we make any change to the account number to make it fit to the required format (removing spaces, padding the account, etc). | Alpha | Optional | N |
| bic8 | BIC8 Flag | Y or N | Optional | N |
| page | page, for pagination of results | Numeric | Optional | |
| logRef | reference | Alphanumeric | Optional | |
| allBranchFlag | All branch Flag | Y o N | Optional | N |
| token | Security token returned after calling the /authenticate endpoint | Alphanumeric & Extended characters | Mandatory |
Response modifications
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 |
| cdtrCompanyName | ||
| accountType | Creditor Account Type | P or B |
| sepaCountry | Flag is the creditor country is SEPA | Y or N |
| ibanCountry | Flag if the country is IBAN Mandatory (M) or Optional (O) | M or O |
| cdtrBranchDetails | ||
| cdtrBranchDetails.sepaDetails.ctStatus | Is the Creditor branch SEPA credit transfer compliant | Y or N |
| cdtrBranchDetails.sepaDetails.ddStatus | Is the Creditor branch SEPA direct debit compliant | Y or N |
| cdtrBranchDetails.sepaDetails.bbStatus | Is the Creditor branch B2B compliant | Y or N |
| cdtrBranchDetails.sepaDetails.ictStatus | Is the Creditor branch SEPA instant credit compliant | Y or N |
| cdtrBranchDetails.additionalData.ssiAvailable | If SSI is available for the creditor branch | Y or N |
| cdtrBranchDetails.additionalData.payServiceAvailable | If pay service is available for the creditor branch | Y or N |
| cdtrBranchDetails.additionalData.contactsAvailable | If there are contacts available for the creditor branch | Y or N |
| recommendation | ||
| recommendation.recommendedBICSWIFTConnected | Flag if recommended BIC is SWIFT Connected | Y or N |
| recommendation.accCurrency | Recommended Currency | |
| sepaStat | Flag for SEPA status | Y or N |
| paymentRequirements | ||
| paymentRequirements.cdtrEmpnum | Creditor employee number flag | Y or N |
| paymentRequirements.cdtrCorpaddr | Creditor Corporate Address flag | Y or N |
| paymentRequirements.cdtrAddr | Creditory full retail address flag | Y or N |
| paymentRequirements.bankAddr | Creditor full Beneficiary bank retail address flag | Y or N |
| paymentRequirements.cdtrNationalId | Creditory national ID flag | Y or N |
| paymentRequirements.cdtrNation | Creditor Nationality flag | Y or N |
| paymentRequirements.cdtrPassnum | Creditory Passport Number flag | Y or N |
| paymentRequirements.ppcStatus | Creditor Payment Reason code Primary Flag | Y or N |
| paymentRequirements.registrationNumber | Creditor registration number flag | Y or N |
| paymentRequirements.cdtrTaxCd | Creditor Tax Code flag | Y or N |
| paymentRequirements.telephoneNumber | Creditor Telephone number flag | Y or N |
| paymentRequirements.status | Status for the payment requirement | Y or N |
| paymentRequirements.comment | Comment for the payment requirement | Y or N |
| errorComment | error comment flag | E |
| page | 0 | |
| pageSize | 20 | |
| pageTotal | 0 | |
| allBranchFlag | all branch flag input | Y or N |
| strict | strict input | N |
Response outcomes
To understand the responses, please refer to Swagger – https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/payer
The recommended fields tell you what we believe you should be using.
| Field Name | Description | Format | ||
| dtrSalName | Creditor salutation | Alpha | ||
| cdtrFirstName | Creditor First Name | Alpha | ||
| cdtrMiddleName | Creditor Middle Name | Alpha | ||
| cdtrLastName | Creditor Last Name | Alpha | ||
| cdtrAddr1 | Creditor Address Line 1 | Alphanumeric | ||
| cdtrAddr2 | Creditor Address Line 2 | Alphanumeric | ||
| cdtrCity | Creditor City | Alphanumeric | ||
| cdtrRegion | Creditor Region | Alphanumeric | ||
| cdtrCompanyName | ||||
| accountType | Creditor Account Type | P or B | ||
| statusAcctType | Status for Account Type validation | Alpha | ||
| commentAcctType | Comment for Account Type validation | Alphanumeric | ||
| status | Overall Status | Alpha | ||
| comment | Overall Comment | Alphanumeric | ||
| applyRef | Alphanumeric | |||
| cdtrCity | Alpha | |||
| cdtrZip | Creditor Zip code | Numeric | ||
| cdtrNatId | Creditor National ID / Sort Code / BIC | Alphanumeric | ||
| cdtrAcct | Creditor Account Number / IBAN / BBAN | Alphanumeric | ||
| cdtrCtryCde | Creditor ISO Country Code | Alpha | ||
| sepaCountry | Flag is the creditor country is SEPA | Y or N | ||
| ibanCountry | Flag if the country is IBAN Mandatory (M) or Optional (O) | Alpha | ||
| cdtrBranchDetails | ||||
| cdtrBranchDetails.bankName | Bank name for the retrieved Creditor Branch Details | Alphanumeric | ||
| cdtrBranchDetails.branch | Branch name for the retrieved Creditor Branch Details | Alpha | ||
| cdtrBranchDetails.street | Street name for the retrieved Creditor Branch Details | Alphanumeric | ||
| cdtrBranchDetails.city | City name for the retrieved Creditor Branch Details | Alpha | ||
| cdtrBranchDetails.postZip | Zip or post code for the retrieved Creditor Branch Details | Numeric | ||
| cdtrBranchDetails.region | Region for the retrieved Creditor Branch Details | Alpha | ||
| cdtrBranchDetails.country | Country for the retrieved Creditor Branch Details | Alpha | ||
| cdtrBranchDetails.codeDetails.codeName1 | Creditor Branch BIC label | Alpha | ||
| cdtrBranchDetails.codeDetails.codeValue1 | Creditor Branch BIC value | Alphanumeric | ||
| cdtrBranchDetails.codeDetails.codeName2 | Creditor Branch CHIPS label | Alpha | ||
| cdtrBranchDetails.codeDetails.codeValue2 | Creditor Branch CHIPS value | Alpha | ||
| cdtrBranchDetails.codeDetails.codeName3 | Creditor Branch BIC-4 label | Alphanumeric | ||
| cdtrBranchDetails.codeDetails.codeValue3 | Creditor Branch BIC-4 value | Alphanumeric | ||
| cdtrBranchDetails.codeDetails.codeName4 | Creditor Branch Domestic Clearing Code label | Alpha | ||
| cdtrBranchDetails.codeDetails.codeValue4 | Creditor Branch Domestic Clearing Code value | Alphanumeric | ||
| cdtrBranchDetails.codeDetails.codeName5 | Creditor Branch Domestic Clearing Code label | Alpha | ||
| cdtrBranchDetails.codeDetails.codeValue5 | Creditor Branch Domestic Clearing Code value | Alphanumeric | ||
| cdtrBranchDetails.sepaDetails.ctStatus | Is the Creditor branch SEPA credit transfer compliant | Alpha | ||
| cdtrBranchDetails.sepaDetails.ddStatus | Is the Creditor branch SEPA direct debit compliant | Alpha | ||
| cdtrBranchDetails.sepaDetails.bbStatus | Is the Creditor branch B2B compliant | Alpha | ||
| cdtrBranchDetails.sepaDetails.ictStatus | Is the Creditor branch SEPA instant credit compliant | Alpha | ||
| cdtrBranchDetails.additionalData.ssiAvailable | If SSI is available for the creditor branch | Alpha | ||
| cdtrBranchDetails.additionalData.payServiceAvailable | If pay service is available for the creditor branch | Alpha | ||
| cdtrBranchDetails.additionalData.contactsAvailable | If there are contacts available for the creditor branch | Alpha | ||
| cdtrBranchDetails.bankToken | Banktoken for the creditor branch, can be used for supplementary calls | Alphanumeric | ||
| cdtrBranchDetails.availLang | Available languages for the Creditor branch | Alpha | ||
| recommendation | ||||
| recommendation.recommendedDomNatId | Recommended Domestic National ID | Alphanumeric | ||
| recommendation.recommendedDomAcct | Recommended Domestic Account Number | Alphanumeric | ||
| recommendation.recommendedDomBIC | Recommended Domestic BIC | Alphanumeric | ||
| recommendation.recommendedIntNatId | Recommended International National ID | Alphanumeric | ||
| recommendation.recommendedIntAcct | Recommended International Account number | Alphanumeric | ||
| recommendation.recommendedIntBIC | Recommended Domestic International BIC | Alphanumeric | ||
| recommendation.recommendedBICSWIFTConnected | Flag if recommended BIC is SWIFT Connected | Alpha | ||
| recommendation.recommendedSWIFTConnectedBIC | Recommended SWIFT Connected BIC | Alphanumeric | ||
| recommendation.accCurrency | Recommended Currency | |||
| cdtrAcctStat | Status for the creditor account | Alphanumeric | ||
| cdtrAcctCom | Comment for the creditor account | Alpha | ||
| holidays.country | Country where holiday is applicable | Alpha | ||
| holidays.title | Title of the Holiday | Alpha | ||
| holidays.date | Date for the holiday | Date | ||
| chrg | Charge Type | Alpha | ||
| recommendedChrg | Our recommended charge type | Alpha | ||
| chrgOpt | Possible charge type options | Alpha | ||
| statusChrg | Status of the charge type validation | Alpha | ||
| commentChrg | Comment for the charge type validation | Alphanumeric | ||
| sepaStat | Flag for SEPA status | Alpha | ||
| trnsDt | Transaction date input | Alpha | ||
| statusTrnsDt | Status for the transaction date validation | Alpha | ||
| commentTrnsDt | Comment for the transaction date validation | Alphanumeric | ||
| recommendedTrnsDt | Recommended Transaction Date | Date | ||
| currencyCode | currency code input | Alpha | ||
| currencyName | Name of the currency code input | Alpha | ||
| currencyStat | Status for the currency code validation | Alpha | ||
| currencyCom | Comment for the currency code validation | Alphanumeric | ||
| pmtInfId | Payment information reference | Alphanumeric | ||
| statusPmtInfId | Status for validation of pmtInfId | Alpha | ||
| commentPmtInfId | Comment validation of pmtInfId | Alpha | ||
| amt | amount used in FATF Validation | Numeric | ||
| statusAmt | status of FATF Validation for amount (amt) | Alpha | ||
| commentAmt | comment of FATF Validation for amount (amt) | Alphanumeric | ||
| cdtrCleansedDetails | Cleansed (FATF) details for the Creditory (cdtr* inputs) | Alpha | ||
| cdtrCleansedDetails.fatfStatus | Status on cleansing data for creditor | Alpha | ||
| cdtrCleansedDetails.fatfComment | Comment on cleansing data for creditor | Alpha | ||
| cdtrCleansedDetails.recomName | Recommended Creditor name | Alpha | ||
| cdtrCleansedDetails.recomAddress | Recommended Address | Alphanumeric | ||
| cdtrCleansedDetails.recomCity | Recommended Creditor City | Alpha | ||
| cdtrCleansedDetails.recomState | Recommended Creditor State | Alpha | ||
| cdtrCleansedDetails.recomPostZipCode | Recommended Creditor Zip Code | Numeric | ||
| paymentRequirements | ||||
| paymentRequirements.cdtrEmpnum | Creditor employee number flag | Alpha | ||
| paymentRequirements.cdtrCorpaddr | Creditor Corporate Address flag | Alpha | ||
| paymentRequirements.cdtrAddr | Creditory full retail address flag | Alpha | ||
| paymentRequirements.bankAddr | Creditor full Beneficiary bank retail address flag | Alpha | ||
| paymentRequirements.cdtrNationalId | Creditory national ID flag | Alpha | ||
| paymentRequirements.cdtrNation | Creditor Nationality flag | Alpha | ||
| paymentRequirements.cdtrPassnum | Creditory Passport Number flag | Alpha | ||
| paymentRequirements.ppcStatus | Creditor Payment Reason code Primary Flag | Alpha | ||
| paymentRequirements.registrationNumber | Creditor registration number flag | Alpha | ||
| paymentRequirements.cdtrTaxCd | Creditor Tax Code flag | Alpha | ||
| paymentRequirements.telephoneNumber | Creditor Telephone number flag | Alpha | ||
| paymentRequirements.status | Status for the payment requirement | Alpha | ||
| paymentRequirements.comment | Comment for the payment requirement | Alpha | ||
| companyId | Company ID of the user | Alphanumeric | ||
| groupId | Group ID | Numeric | ||
| errorComment | error comment flag | Alpha | ||
| page | Numeric | |||
| pageSize | Numeric | |||
| pageTotal | Numeric | |||
| allBranchFlag | all branch flag input | Alphanumeric | ||
| strict | strict input | Alphanumeric | ||
| ref | reference | Alphanumeric | ||
| extendedToken | extended token for the transaction, to be used on supplementary calls | Alphanumeric | ||
| freeToken | free token for the transaction, to be used on supplementary calls | Alphanumeric |
Making the account number mandatory
If you need the account number to be mandatory then please got to the self service hub using the link below.
https://management.bankersalmanac.com/vss-web
Then go to the error module in the bottom left and change the error below to FAIL
08an Account number not entered
Then save the changes and the service will set the account number as mandatory.
Test example
cdtrNatId
The creditors domestic bank code, or BIC
“309408”,
cdtrAcct
The creditors account number or IBAN
“1638696”,
freeToken