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.comvalidate-api/rest/convert/1.0.1.1
Request
| Field_Name | Field Long Name | Description | Mandatory or Optional | Type | Size |
| Dbtr_Nat_Id | Debtor National ID | As input | M | ||
| Dbtr_Acc | Debtor Account Number | As input | M | ||
| Dbtr_Ctry_Cde | Debtor Country Code | As input | M | ||
| Dbtr_Ccy_Cde | Debtor Currrency Code | As input | M | ||
| Dbtr_Nme | Debtor Name | As input | M | ||
| Dbtr_Addr | Debtor Address 1 | As input | M | ||
| Dbtr_Cty | Debtor City | As input | M | ||
| Dbtr_Ste | Debtor State | As input | M | ||
| Dbtr_Zip | Debtor Zip | As input | M | ||
| Dbtr_Dtl | Debtor Details | Merged client details instead of split details | M | ||
| Cdtr_Nat_Id | Creditor National ID | As input | M | ||
| Cdtr_Acc | Creditor Account Number | As input | M | ||
| Cdtr_Ctry_Cde | Creditor Country Code | As input | M | ||
| Cdtr_Ccy_Cde | Creditor Currrency Code | As input | M | ||
| Cdtr_Nme | Creditor Name | As input | M | ||
| Cdtr_Addr | Creditor Address 1 | As input | M | ||
| Cdtr_Cty | Creditor City | As input | M | ||
| Cdtr_Ste | Creditor State | As input | M | ||
| Cdtr_Zip | Creditor Zip | As input | M | ||
| Cdtr_Dtl | Creditor Details | Merged client Name and Address details instead of split details | M | ||
| Chrg | Charge type | As input | M | ||
| PmtInfId | Payment Id | Unique payment reference | M | ||
| Trns_Dt | Transaction Date | Date transaction sent | M | ||
| Amt | Amount | Amount being paid | M |
Response
| Field Name | Field Long Name | Description | Mandatory or Optional | Type | Size | |
| Debtor Fields | Dbtr_Nat_Id | Debtor National ID | As input | M | ||
| Dbtr_Acc | Debtor Account Number | As input | M | |||
| Dbtr_Ctry_Cde | Debtor Country Code | As input | M | |||
| Dbtr_Ccy_Cde | Debtor Currrency Code | As input | M | |||
| Dbtr_Nme | Debtor Name | As input | M | |||
| Dbtr_Addr | Debtor Address 1 | As input | M | |||
| Dbtr_Cty | Debtor City | As input | M | |||
| Dbtr_Ste | Debtor State | As input | M | |||
| Dbtr_Zip | Debtor Zip | As input | M | |||
| Rec_Dbtr_Nme | Recommended Debtor Name | Cleansed field | M | |||
| Rec_Dbtr_Addr | Recommended Debtor Address 1 | Cleansed field | M | |||
| Rec_Dbtr_Cty | Recommended Debtor City | Cleansed field | M | |||
| Rec_Dbtr_Ste | Recommended Debtor State | Cleansed field | M | |||
| Rec_Dbtr_Zip | Recommended Debtor Zip | Cleansed field | M | |||
| Dbtr_FATF_Stat | Debtor FATF Status | PASS, CAUTION OR FAIL | M | |||
| Dbtr_FATF_Com | Debtor FATF Comment | Descriptive reason for status with code | M | |||
| Dbtr_FinInst_Nme | Debtor Bank Name | Bank Name | M | |||
| Dbtr_FinInst_Addr | Debtor Bank Address 1 | Bank Address 1 | M | |||
| Dbtr_FinInst_Cty | Debtor Bank City | Bank City | M | |||
| Dbtr_FinInst_Ste | Debtor Bank State | Bank State or County | M | |||
| Dbtr_FinInst_Zip | Debtor Bank Zip | Bank Zip Code | M | |||
| Dbtr_FinInst_Ccy_Cde | Debtor Bank Country Code | Bank Country Code | M | |||
| Rec_Dbtr_Nat_ID | Recommended Debtor Nat ID | Recommended domestic bank code | M | |||
| Rec_Dbtr_Acc | Recommended Debtor Acc No | Recommended account number | M | |||
| Rec_Dbtr_BIC | Recommended Debtor BIC | Recommended BIC | M | |||
| Rec_Dbtr_BIC_Cnt | Recommended Debtor BIC Connected | Is the SWIFT BIC Connected | M | |||
| Dbtr_Acc_stat | Payment Details Status | PASS, CAUTION OR FAIL | M | |||
| Dbtr_Acc_Com | Payment Details Comment | Descriptive reason for status with code | M | |||
| Creditor Fields | Cdtr_Nat_Id | Creditor National ID | As input | M | ||
| Cdtr_Acc | Creditor Account Number | As input | M | |||
| Cdtr_Ctry_Cde | Creditor Country Code | As input | M | |||
| Cdtr_Ccy_Cde | Creditor Currrency Code | As input | M | |||
| Cdtr_Nme | Creditor Name | As input | M | |||
| Cdtr_Addr | Creditor Address 1 | As input | M | |||
| Cdtr_Cty | Creditor City | As input | M | |||
| Cdtr_Ste | Creditor State | As input | M | |||
| Cdtr_Zip | Creditor Zip | As input | M | |||
| Rec_Cdtr_Nme | Recommended Creditor Name | Cleansed field | M | |||
| Rec_Cdtr_Addr | Recommended Creditor Address 1 | Cleansed field | M | |||
| Rec_Cdtr_Cty | Recommended Creditor City | Cleansed field | M | |||
| Rec_Cdtr_Ste | Recommended Creditor State | Cleansed field | M | |||
| Rec_Cdtr_Zip | Recommended Creditor Zip | Cleansed field | M | |||
| Cdtr_Acc_Ccy_Cde | Creditor Account Currency Code | Currency of Account | M | |||
| Cdtr_FATF_Stat | Ordering FATF Status | PASS, CAUTION OR FAIL | M | |||
| Cdtr_FATF_Com | Ordering FATF Comment | Descriptive reason for status with code | M | |||
| Cdtr_FinInst_Nme | Creditor Bank Name | Bank Name | M | |||
| Cdtr_FinInst_Addr | Creditor Bank Address 1 | Bank Address 1 | M | |||
| Cdtr_FinInst_Cty | Creditor Bank City | Bank City | M | |||
| Cdtr_FinInst_Ste | Creditor Bank State | Bank State or County | M | |||
| Cdtr_FinInst_Zip | Creditor Bank Zip | Bank Zip Code | M | |||
| Cdtr_FinInst_Ccy_Cde | Creditor Bank Country Code | Bank Country Code | M | |||
| Rec_Cdtr_Nat_ID | Recommended Creditor Nat ID | Recommended bank code | M | |||
| Rec_Cdtr_Acc | Recommended Creditor Acc No | Recommended account number | M | |||
| Rec_Cdtr_BIC | Recommended Creditor BIC | Recommended BIC | M | |||
| Rec_Cdtr_Nat_ID | Recommended Creditor Nat ID | Recommended International bank code | O | |||
| Rec_Cdtr_Acc | Recommended Creditor Acc No | Recommended International account number | O | |||
| Rec_Cdtr_BIC | Recommended Creditor BIC | Recommended International BIC | O | |||
| Rec_Cdtr_Nat_ID | Recommended Creditor Nat ID | Recommended Domestic bank code | O | |||
| Rec_Cdtr_Acc | Recommended Creditor Acc No | Recommended Domestic account number | O | |||
| Rec_Cdtr_BIC | Recommended Creditor BIC | Recommended Domestic BIC | O | |||
| Rec_Cdtr_BIC_Cnt | Recommended Creditor BIC Connnected | Is the SWIFT BIC Connected | M | |||
| Cdtr_Acc_Stat | Payment Details Status | PASS, CAUTION OR FAIL | M | |||
| Cdtr_Acc_Com | Payment Details Comment | Descriptive reason for status with code | M | |||
| General Fields | Chrg | Charge | As input | M | ||
| Rec_Chrg | Recommended Charging | Recommended charging type OUR, BEN, SHA, SLEV | M | |||
| Chrg_Opt | Charging Options | Charging types available OUR, BEN, SHA, SLEV | M | |||
| Rec_Chrg_Stat | Recommended Charging Status | PASS, CAUTION OR FAIL | M | |||
| Rec_Chrg_Com | Recommended Charging Comment | Descriptive reason for status with code | M | |||
| PmtInfId | Payment Id | Unique payment reference | M | |||
| PmtInfId_Stat | Payment Id Status | PASS, CAUTION OR FAIL | M | |||
| PmtInfId_Com | Payment Id Comment | Descriptive reason for status with code | M | |||
| Trns_Dt | Transaction Date | Date transaction sent | M | |||
| Prd_Dt | Predicted t+date | Reciept of payment date | M | |||
| Non_Wrk_Dys | Non-working days | Country Code and date of non-working days | M | |||
| Amt | Amount | Amount being paid | M | |||
| det_Cdtr_Nat_id_err | Detailed National ID Error | M | ||||
| det_Cdtr_Acc_err | Detailed Creditor Account Number Error | M | ||||
| det_Dbtr_Nat_id_err | Detailed National ID Error | M | ||||
| det_Dbtr_Acc_err | Detailed Creditor Account Number Error | M | ||||
| sepa_Ctry | SEPA Country | M | ||||
| iban_Ctry | IBAN Mandatory Country | M | ||||
| lang_Avail | Languages Available | M | ||||
| crrp_Avail | Correspondent Available | M | ||||
| tx_Req | Tax Code Required | M | ||||
| pay_Purp | Payment Purpose required | M | ||||
| hol_Avail | Holiday Available | M | ||||
| bra_Tok | Branch token | M | ||||
| head_Tok | Head Office Token | M | ||||
| pay_Bra_tok | Payment Branch Token | M | ||||
| free_Token | Free Token for use with above tokens | M | ||||
| our_Ref | Apply Financial Unique Reference | M |