Modulus Check
This service allows to check the validity of a account number and sortcode, returning various details about the account
| Method | Purpose |
|---|---|
| POST | Modulus Check Account Details |
POST
Action: Modulus Check Account Details.
Method: POST
URL: https://api.smarterpaycloud.com/service.svc/moduluscheck
Request Parameters
| Property | Mandatory | Description |
|---|---|---|
| account_number | True | Must be 8 numbers with leading zeros, no spaces or hyphens |
| sort_code | True | Must be 6 numbers with leading zeros, no spaces or hyphens |
| account_name | False | If account validation is used this propery is required, and is the name used to % match against the validation check. |
| account_validation | False | Provide the property, with a value of “true”, to request, if enabled, account validation on the Bank Account. |
| metadata | False | If account validation is used, this is an optional string that will be passed through to the finishing page. |
| account_validation_return_url | False | If account validation is used, this is an optional url for the validation process to finish on, for example a custom thank you page. |
Request Sample
{
"Modulus_Check":
{
"account_number":"75849855",
"sort_code":"200052",
"account_name":"Test Account",
"account_validation":true,
"metadata":"metadata string",
"account_validation_return_url":"https://accountvalidation.smarterpaycloud.com/test"
}
}
Response Parameters
| Property | Description |
|---|---|
| AccountCodeOK | Returns true if account number entered is valid |
| account_number | Supplied account number |
| bank_address1 | Address line one for bank |
| bank_address2 | Address line two for bank |
| bank_address3 | Address line three for bank |
| bank_address4 | Address line four for bank |
| bank_addressPostCode | Postal code for bank |
| bank_name | Name of bank |
| credits_allowed | Returns true if credits are setup with bank |
| direct_debit_instruction_ok | Returns true if direct debit instruction is ok |
| direct_debits | Returns true if direct debits are available |
| sort_code | Supplied sort code |
| sort_code_ok | Returns true if sort code is valid |
| Telephone | Returns telephone number |
| Error | Deprecated. Returns “” |
| account_validation | If provided in the request, will return the value “true” or “false” |
| account_validation_return_url | If provided in the request, will return the string value |
| account_validation_url | If '“account_validation”:true' provided in the request, and it is enabled, will return the account validation link |
| account_validation_id | If '“account_validation”:true' provided in the request, and it is enabled, will return the ID of the Associated Acount Validation record |
| account_name | If provided in the request, will return the string value |
| metadata | If provided in the request, will return the string value |
Response Sample
{
"Modulus_Check": {
"AccountCodeOK": true,
"Error": "",
"Telephone": "020 76232323",
"account_number": "75849855",
"bank_address1": "5 The North Colonnade",
"bank_address2": "Canary Wharf",
"bank_address3": "",
"bank_address4": "",
"bank_addressPostCode": "E14 4PU",
"bank_addressTown": "London",
"bank_name": "BARCLAYS BANK PLC",
"branch_title": "GLOBAL TREASURY SETTLEMENT",
"credits_allowed": true,
"direct_debit_Instruction_ok": true,
"direct_debits": true,
"sort_code": "200052",
"sort_code_ok": true,
"account_validation": true,
"account_validation_return_url": "https://accountvalidation.smarterpaycloud.com/test",
"account_validation_url": "https://accountvalidation.smarterpaycloud.com",
"account_validation_id": "AV01RM741EJ5DEJ3XGLW",
"account_name": "Test Account",
"metadata": "metadata string"
}
}