Endpoint: https://api.validate.bankersalmanac.com/payer-payee
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/payerPayee
Overview
This call validates:
Senders and Receivers Bank Code
The sender and receivers bank code to ensure that the bank branch exists and is currently valid
Senders and Receivers Account Number
The sender and receivers account number to ensure that it’s valid and can exist at the branch.
Payment id
The payment id will be validated for format and length
Senders and Receivers Name
The sender and receivers name meets the FATF requirements set out in the regulations and by your bank.
The minimum length of name is configurable in the self service hub.
The solution will also fail names that are not complete (e.g. if the persons name does not consist of a first and last name). Therefore if one section of the name is for example Mr. then it will fail. These titles are not part of the name as recognised by FATF and are not considered during validation. The titles that are not allowed can be configured in the self service hub by an administrator.
Senders and Receivers Address
The address contains only characters that are ISO and SWIFT message compatible.
This call will replace any non-SWIFT/ISO compliant characters with compliant characters.
Endpoint inputs
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| dbtrNme | Debtor Name | Alpha | Optional | |
| dbtrAddr | Debtor Address 1 | Alphanumeric | Optional | |
| dbtrCty | Debtor City | Alpha | Optional | |
| dbtrSte | Debtor State | Alpha | Optional | |
| dbtrZip | Debtor Zip | Alphanumeric | Optional | |
| dbtrNatId | Debtor National ID | Alphanumeric | Optional | |
| dbtrAcct | Debtor Account Number | Alphanumeric | Optional | |
| dbtrCtryCde | Debtor Country Code | Alpha | Optional | |
| cdtrNme | Creditor Name | Alpha | Optional | |
| cdtrAddr | Creditor Address 1 | Alphanumeric | Optional | |
| cdtrCty | Creditor City | Alpha | Optional | |
| cdtrSte | Creditor State | Alpha | Optional | |
| cdtrZip | Creditor Zip | Alphanumeric | Optional | |
| cdtrNatId | Creditor National ID | Alphanumeric | Optional | |
| cdtrAcct | Creditor Account Number | Alphanumeric | Optional | |
| cdtrCtryCde | Creditor Country Code | Alpha | Optional | |
| chrg | Charge type | Alpha | Optional | |
| pmtInfId | Payment Id | Alphanumeric | Optional | |
| trnsDt | Transaction Date (format yyyy/mm/dd) | Alphanumeric & Extended Characters | Optional | |
| currencyCode | Creditor ISO Currency Code | Alpha | Optional | |
| amt | Amount | Numeric | Optional | |
| noBranch | Option to show branch or not, Y- no branch shown, N – show all branches. | Y or N | Optional | |
| isoAddr | SO Address flag, Y-truncate to 70 char (accepted ISO address format) : Bank Name, Branch, Street, City, Post Zip, Region, Country. | Y or N | Optional | |
| payBranchType | Payment Branch Type | I IBAN, B Branch, H Head Office, R Routing, P Payment | Optional | |
| allRecommend | Optional | |||
| strict | Strict flag | Alpha | Optional | N |
| bic8 | es/No flag if you wish any head office with xxx to be returned as a BIC8 or BIC11 | Y or N | Optional | |
| page | his requests the page number you are after, the default for this is 1 | Numeric | Optional | 1 |
| logRef | ||||
| token | Security Token | Alphanumeric & Extended Characters | Mandatory |
Response modifications
| Field Name | Description | Format |
| dbtrSsiAvailable | Y or N | |
| dbtrHolidayAvailable | Y or N | |
| dbtrMessageAvailable | Y or N | |
| dbtrLangAvail | Y or N | |
| cdtrSsiAvailable | Y or N | |
| cdtrHolidayAvailable | Y or N | |
| cdtrMessageAvailable | Y or N | |
| cdtrLangAvail | Y or N | |
| companyId | Company Id | |
| errorComment | f the field is set to E then you will be able to edit the error text in the self service hub | E |
| noBranch | Option to show branch or not, Y- no branch shown, N – show all branches. | Y or N |
| isoAddr | SO Address flag, Y-truncate to 70 char (accepted ISO address format) : Bank Name, Branch, Street, City, Post Zip, Region, Country. | Y or N |
| payBranchType | Payment Branch Type | I IBAN, B Branch,H Head Office,R Routing, P Payment |
| allRecommend | All recommended flag | Y or N |
| strict | Strict flag | 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/payerPayee
| Field Name | Description | Format | ||
| dbtrAddr | Debtor Address 1 | Alphanumeric | ||
| dbtrCty | Debtor City | Alpha | ||
| dbtrSte | Debtor State | Alpha | ||
| dbtrZip | Debtor Zip | Alphanumeric | ||
| dbtrNatId | Debtor National ID | Alphanumeric | ||
| dbtrAcct | Debtor Account Number | Alphanumeric | ||
| dbtrCtryCde | Debtor Country Code | Alpha | ||
| dbtrFinInstNme | Debtor Country Code | Alpha | ||
| dbtrFinInstAddr | Creditor Address 1 | Alphanumeric | ||
| dbtrFinInstCty | Creditor City | Alpha | ||
| dbtrFinInstSte | Creditor State | Alpha | ||
| dbtrFinInstZip | Creditor Zip | Alphanumeric | ||
| dbtrFinInstCtryCde | Creditor National ID | Alphanumeric | ||
| dbtrSepaCountry | Creditor Account Number | Alphanumeric | ||
| dbtrIbanCountry | Creditor Country Code | Alpha | ||
| dbtrSsiAvailable | ||||
| dbtrHolidayAvailable | ||||
| dbtrMessageAvailable | ||||
| dbtrLangAvail | ||||
| payPurpSend | ||||
| dbtrNonWrkDys | ||||
| recommendedDbtrNatIddom | ||||
| recommendedDbtrAcctdom | ||||
| recommendedDbtrBICdom | ||||
| recommendedDbtrNatIdint | ||||
| recommendedDbtrAcctint | ||||
| recommendedDbtrBICint | ||||
| recommendedDbtrBICSWIFTConnected | ||||
| recDbtrNme | ||||
| recDbtrAddr | ||||
| recDbtrCty | ||||
| recDbtrSte | ||||
| recDbtrZip | ||||
| recDbtrDtl | ||||
| dbtrFATFStat | ||||
| dbtrFATFCom | ||||
| dbtrAcctStat | ||||
| dbtrAcctCom | ||||
| DS | ||||
| cdtrNme | ||||
| cdtrAddr | ||||
| cdtrCty | ||||
| cdtrSte | ||||
| cdtrZip | ||||
| cdtrNatId | ||||
| cdtrAcct | ||||
| cdtrCtryCde | ||||
| cdtrFinInstNme | ||||
| cdtrFinInstAddr | ||||
| cdtrFinInstCty | ||||
| cdtrFinInstSte | ||||
| cdtrFinInstZip | ||||
| cdtrFinInstCtryCde | ||||
| cdtrSepaCountry | ||||
| cdtrIbanCountry | ||||
| cdtrSsiAvailable | ||||
| cdtrHolidayAvailable | ||||
| cdtrMessageAvailable | ||||
| cdtrLangAvail | ||||
| payPurpRec | ||||
| cdtrNonWrkDys | ||||
| recommendedCdtrNatIddom | ||||
| recommendedCdtrAcctdom | ||||
| recommendedCdtrBICdom | ||||
| recommendedCdtrNatIdint | ||||
| recommendedCdtrAcctint | ||||
| recommendedCdtrBICint | ||||
| recommendedCdtrBICSWIFTConnected | ||||
| recCdtrNme | ||||
| recCdtrAddr | ||||
| recCdtrCty | ||||
| recCdtrSte | ||||
| recCdtrZip | ||||
| recCdtrDtl | ||||
| cdtrFATFStat | ||||
| cdtrFATFCom | ||||
| cdtrAcctStat | ||||
| cdtrAcctCom | ||||
| chrg | ||||
| recommendedChrg | ||||
| chrgOpt | ||||
| recommendedChrgStat | ||||
| recommendedChrgCom | ||||
| sepaStat | ||||
| trnsDt | ||||
| trnsDtStat | ||||
| trnsDtCom | ||||
| prdDt | ||||
| nonWrkDys | ||||
| currencyCode | ||||
| currencyName | ||||
| currencyStat | ||||
| currencyCom | ||||
| amt | ||||
| amtStat | ||||
| amtCom | ||||
| otherFldsStat | ||||
| otherFldsCom | ||||
| pmtInfId | ||||
| pmtInfIdStat | ||||
| pmtInfIdCom | ||||
| companyId | Company Id | |||
| groupId | The group id that this data should be saved in. | Alphanumeric & Extended Characters | ||
| errorComment | f the field is set to E then you will be able to edit the error text in the self service hub | E | ||
| page | This requests the page number you are after, the default for this is 1 | Numeric | ||
| pageSize | This defines the number of branches on a page, the default is 10 | Numeric | ||
| pageTotal | The total number of page | Numeric | ||
| noBranch | Option to show branch or not, Y- no branch shown, N – show all branches. | Y or N | ||
| isoAddr | SO Address flag, Y-truncate to 70 char (accepted ISO address format) : Bank Name, Branch, Street, City, Post Zip, Region, Country. | Y or N | ||
| payBranchType | Payment Branch Type | I IBAN, B Branch,H Head Office,R Routing, P Payment | ||
| allRecommend | All recommended flag | Y or N | ||
| strict | Strict flag | Y or N | ||
| requestingProductId | Requesting product id | Alphanumeric | ||
| token | Security Token | Alphanumeric & Extended Characters | ||
| ref | Reference | Alphanumeric & Extended Characters | ||
| nonWorkDays | ||||
| country | Country where’s the none work day | |||
| title | Title of the none work day | |||
| date | Date of the none work day |
Test example
free token