Bank Account Check

Confirmation of Payee check.

Method	Purpose
POST	Confirmation of Payee check
GET (Singular)	Retrieve request record

POST

Action: Confirmation of Payee check.
Method: POST
URL: https://api.smarterpaycloud.com/service.svc/bankaccountcheck

Request Parameters

Property	Mandatory	Description
account_name	Yes	Name on account to check. Maximum 80 characters.
account_number	Yes	Account number to check. Maximum 8 digits.
account_type	Yes	1 = Personal Account, 2 = Business Account.
check_type	Yes	1 = Confirmation of Payee check.
metadata	No	Custom metadata. Maximum 255 characters.
sort_code	Yes	Sort code to check. Maximum 6 digits

Request Sample

{
 "bank_account_check":
  {
   "check_type": 1,
   "account_number":"11111110",
   "sort_code":"000000",
   "account_name":"Test User",
   "account_type": 1,
   "metadata":"test"
  }
}

Response Parameters

Property	Description
account_name	Account Name.
account_number	Account number.
account_type	1 = Personal Account, 2 = Business Account.
check_type	1 = Confirmation of Payee check.
client_reference_id	Optional Identifier.
confirmation_of_payer.account_type_result	Will return “true” if the account type is correct or “false” if it isn't correct.
confirmation_of_payer.name_match_result	Will return whether the name was a Full, Close or No Match.
confirmation_of_payer.reason_code	Returned reason code.
confirmation_of_payer.result	Will return “true” if an exact match was found and “false” if it wasn't.
confirmation_of_payer.result_text	Result in text form giving more details if there wasn't a match.
confirmation_of_payer.returned_customer_name	Will return a value if the name was a close but inexact match.
created_at	Datetime formatted as ISO8601.
created_by	Will return “null”.
edited_at	Datetime formatted as ISO8601.
edited_by	Will return “null”.
id	ID of the request record.
metadata	Custom metatdata.
sort_code	Sort Code.

Response Sample

{
    "bank_account_check": {
        "id": "AC01RZO41Y8DQZP0GNLW",
        "created_at": "2026-05-13T09:16:23Z",
        "edited_at": "2026-05-13T09:16:23Z",
        "created_by": null,
        "edited_by": null,
        "check_type": 1,
        "account_number": "11111110",
        "sort_code": "000000",
        "account_name": "Test User",
        "account_type": 1,
        "metadata": "test",
        "confirmation_of_payer": {
            "returned_customer_name": "Test User",
            "result": true,
            "result_text": "The account name provided is a match.",
            "name_match_result": "Full",
            "account_type_result": true,
            "reason_code": "MATC"
        },
        "client_reference_id": null
    }
}

GET (Singular)

Action: Retrieve Bank Account details.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/bankaccountcheck/{ID}

{ID} denotes ID of record.

Response Parameters

Property	Description
account_name	Account Name.
account_number	Account number.
account_type	1 = Personal Account, 2 = Business Account.
check_type	1 = Confirmation of Payee check.
client_reference_id	Optional Identifier.
confirmation_of_payer.account_type_result	Will return “true” if the account type is correct or “false” if it isn't correct.
confirmation_of_payer.name_match_result	Will return whether the name was a Full, Close or No Match.
confirmation_of_payer.reason_code	Returned reason code.
confirmation_of_payer.result	Will return “true” if an exact match was found and “false” if it wasn't.
confirmation_of_payer.result_text	Result in text form giving more details if there wasn't a match.
confirmation_of_payer.returned_customer_name	Will return a value if the name was a close but inexact match.
created_at	Datetime formatted as ISO8601.
created_by	Will return “null”.
edited_at	Datetime formatted as ISO8601.
edited_by	Will return “null”.
id	ID of the request record.
metadata	Custom metatdata.
sort_code	Sort Code.

Response Sample

{
    "bank_account_check": {
        "id": "AC01RZO41Y8DQZP0GNLW",
        "created_at": "2026-05-13T09:16:23Z",
        "edited_at": "2026-05-13T09:16:23Z",
        "created_by": null,
        "edited_by": null,
        "check_type": 1,
        "account_number": "11111110",
        "sort_code": "000000",
        "account_name": "Test User",
        "account_type": 1,
        "metadata": "test",
        "confirmation_of_payer": {
            "returned_customer_name": "Test User",
            "result": true,
            "result_text": "The account name provided is a match.",
            "name_match_result": "Full",
            "account_type_result": true,
            "reason_code": "MATC"
        },
        "client_reference_id": null
    }
}