Bank Account Check

Confirmation of Payee check.

Method	Purpose
POST (Singular)	Confirmation of Payee check
POST (List)	Confirmation of Payee check from a list
GET (Singular)	Retrieve request record
GET (List)	Retrieve request details in a list

POST (Singular)

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
    }
}

POST (List)

Action: Confirmation of Payee check from a list.
Method: POST
URL: https://api.smarterpaycloud.com/service.svc/bankaccountchecks

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_checks": [
    {
      "account_name": "Fred Bloggs",
      "account_number": "11111114",
      "sort_code": "000000",
      "account_type": 1,
      "check_type": 2,  
      "client_reference_id": "ref01",
      "secondary_reference": null
    },
    {
      "account_name": "Jane Doe",
      "account_number": "11111115",
      "sort_code": "000000",
      "account_type": 2,
      "check_type": 2, 
      "client_reference_id": "ref02",
      "secondary_reference": null
    }
  ]
}

Response

Response Parameters

Property	Description
id	The ID of the Record.
created_at	Datetime formatted as ISO8601.
edited_at	Datetime formatted as ISO8601.
file_name	System generated filename.
status	Status of the Request. Will be set as “pending”.
no_of_accounts	Number of accounts in the request to be checked.
results	Results block for the checks. Initially it will be empty.

Response Sample

{
    "id": "AC02WZQ0583DG9J6KNOE",
    "created_at": "2026-10-23T15:40:39Z",
    "edited_at": "2026-10-23T15:40:40Z",
    "created_by": null,
    "edited_by": null,
    "file_name": "API-batch-20261023144039428.csv",
    "status": "pending",
    "no_of_accounts": 1,
    "results": []
}

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
    }
}

Action: Retrieve Bank Account detail from a lists.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/bankaccountchecks/{ID}

{ID} denotes ID of record.

Response Parameters

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

Response Sample

{
    "id": "AC02Q7ZGLJL23K8W53EO",
    "created_at": "2026-10-23T15:47:42Z",
    "edited_at": "2026-10-23T15:48:14Z",
    "created_by": null,
    "edited_by": null,
    "file_name": "API-batch-20261023144742328.csv",
    "status": "processing",
    "no_of_accounts": 2,
    "results": [
        {
            "id": "AC015OW1YJV63008X29L",
            "created_at": "2026-10-23T15:48:14Z",
            "edited_at": "2026-10-23T15:48:14Z",
            "created_by": null,
            "edited_by": null,
            "check_type": 1,
            "account_number": "11111114",
            "sort_code": "000000",
            "account_name": "Fred Bloggs",
            "account_type": 1,
            "metadata": "",
            "confirmation_of_payer": {
                "returned_customer_name": null,
                "result": false,
                "result_text": null,
                "name_match_result": null,
                "account_type_result": false,
                "reason_code": null
            },
            "client_reference_id": "ref01",
            "secondary_reference": null
        },
        {
            "id": "AC01GRM9OPEYK678024D",
            "created_at": "2026-10-23T15:48:14Z",
            "edited_at": "2026-10-23T15:48:14Z",
            "created_by": null,
            "edited_by": null,
            "check_type": 1,
            "account_number": "11111115",
            "sort_code": "000000",
            "account_name": "Jane Doe",
            "account_type": 2,
            "metadata": "",
            "confirmation_of_payer": {
                "returned_customer_name": null,
                "result": false,
                "result_text": null,
                "name_match_result": null,
                "account_type_result": false,
                "reason_code": null
            },
            "client_reference_id": "ref02",
            "secondary_reference": null
        }
    ]
}

Bank Account Check

POST (Singular)

POST (List)

Response

GET (Singular)

GET (List)