What does it do
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.
Method
POST command, in “application/json” format
The endpoint is
https://validate.bankersalmanac.com/validate-api/rest/convert/1.0.12
Request
| Field Name | Field Long Name | Description | Type | Size |
| Dbtr_Nat_Id | Debtor National ID | As input | ||
| Dbtr_Acc | Debtor Account Number | As input | ||
| Dbtr_Ctry_Cde | Debtor Country Code | As input | ||
| Dbtr_Ccy_Cde | Debtor Currency Code | As input | ||
| Dbtr_Nme | Debtor Name | As input | ||
| Dbtr_Addr | Debtor Address 1 | As input | ||
| Dbtr_Cty | Debtor City | As input | ||
| Dbtr_Ste | Debtor State | As input | ||
| Dbtr_Zip | Debtor Zip | As input | ||
| Dbtr_Dtl | Debtor Details | Merged client details instead of split details | ||
| Cdtr_Nat_Id | Creditor National ID | As input | ||
| Cdtr_Acc | Creditor Account Number | As input | ||
| Cdtr_Ctry_Cde | Creditor Country Code | As input | ||
| Cdtr_Ccy_Cde | Creditor Currency Code | As input | ||
| Cdtr_Nme | Creditor Name | As input | ||
| Cdtr_Addr | Creditor Address 1 | As input | ||
| Cdtr_Cty | Creditor City | As input | ||
| Cdtr_Ste | Creditor State | As input | ||
| Cdtr_Zip | Creditor Zip | As input | ||
| Cdtr_Dtl | Creditor Details | Merged client Name and Address details instead of split details | ||
| Chrg | Charge type | As input | ||
| PmtInfId | Payment Id | Unique payment reference | ||
| Trns_Dt | Transaction Date | Date transaction sent | ||
| Amt | Amount | Amount being paid |
Response
| Field Name | Field Long Name | Description | Type | Size |
| Dbtr_Nat_Id | Debtor National ID | As input | ||
| Dbtr_Acc | Debtor Account Number | As input | ||
| Dbtr_Ctry_Cde | Debtor Country Code | As input | ||
| Dbtr_Ccy_Cde | Debtor Currency Code | As input | ||
| Dbtr_FinInst_Nme | Debtor Bank Name | Bank Name | ||
| Dbtr_FinInst_Addr | Debtor Bank Address 1 | Bank Address 1 | ||
| Dbtr_FinInst_Cty | Debtor Bank City | Bank City | ||
| Dbtr_FinInst_Ste | Debtor Bank State | Bank State or County | ||
| Dbtr_FinInst_Zip | Debtor Bank Zip | Bank Zip Code | ||
| Dbtr_FinInst_Ctry_Cde | Debtor Bank Country Code | Bank Country Code | ||
| Rec_Dbtr_Nat_ID | Recommended Debtor Nat ID | Recommended domestic bank code | ||
| Rec_Dbtr_Acc | Recommended Debtor Acc No | Recommended account number | ||
| Rec_Dbtr_BIC | Recommended Debtor BIC | Recommended BIC | ||
| Dbtr_Acc_stat | Payment Details Status | PASS, CAUTION OR FAIL | ||
| Dbtr_Acc_Com | Payment Details Comment | Descriptive reason for status with code | ||
| Cdtr_Nat_Id | Creditor National ID | As input | ||
| Cdtr_Acc | Creditor Account Number | As input | ||
| Cdtr_Ctry_Cde | Creditor Country Code | As input | ||
| Cdtr_Ccy_Cde | Creditor Currency Code | As input | ||
| Cdtr_FinInst_Nme | Creditor Bank Name | Bank Name | ||
| Cdtr_FinInst_Addr | Creditor Bank Address 1 | Bank Address 1 | ||
| Cdtr_FinInst_Cty | Creditor Bank City | Bank City | ||
| Cdtr_FinInst_Ste | Creditor Bank State | Bank State or County | ||
| Cdtr_FinInst_Zip | Creditor Bank Zip | Bank Zip Code | ||
| Cdtr_FinInst_Ctry_Cde | Creditor Bank Country Code | Bank Country Code | ||
| Rec_Cdtr_Nat_ID | Recommended Creditor Nat ID | Recommended domestic bank code | ||
| Rec_Cdtr_Acc | Recommended Creditor Acc No | Recommended account number | ||
| Rec_Cdtr_BIC | Recommended Creditor BIC | Recommended BIC | ||
| Cdtr_Acc_Stat | Payment Details Status | PASS, CAUTION OR FAIL | ||
| Cdtr_Acc_Com | Payment Details Comment | Descriptive reason for status with code | ||
| Chrg | Charge | As input | ||
| Rec_Chrg | Recommended Charging | Recommended charging type OUR, BEN, SHA, SLEV | ||
| Chrg_Opt | Charging Options | Charging types available OUR, BEN, SHA, SLEV | ||
| Rec_Chrg_Stat | Recommended Charging Status | PASS, CAUTION OR FAIL | ||
| Rec_Chrg_Com | Recommended Charging Comment | Descriptive reason for status with code | ||
| SEPA_Stat | SEPA Status | Y/N | ||
| PmtInfId | Payment Id | Unique payment reference | ||
| Trns_Dt | Transaction Date | Date transaction sent | ||
| Prd_Dt | Predicted t+date | Receipt of payment date | ||
| Non_Wrk_Dys | Non-working days | Country Code and date of non-working days |