Common Responses for the object.
Response Parameters
Property | Description |
---|---|
account_name | Account name |
account_number | Account number |
account_validation_url | Account validation url |
client_bank_account_id | ID of the client bank account |
error_message | Account validation error message, if provided |
id | Unique identifier of the record |
mandate_id | ID of that associated Mandate |
message | Account validation message, if populated |
metadata | Record metadata |
metadata_bank_account | Custom metadata that will be added to the Bank Account record |
metadata_mandate | Custom metadata that will be added to the Mandate record. |
report | JSON formatted response, or null if not populated |
reference | Mandate AUDDIS reference, if provided |
return_url | Return URL, if provded |
sort_code | Sort code |
successful_validation | “True” if succesfully validate, “False” if not attempted or failed validation |
Response Sample
{ "account_validation": { "id": "AV016MQ0KN6XY6POXZG6", "metadata": null, "sort_code": "902127", "account_number": "29823529", "account_name": "J Hetfield", "mandate_id": "M01LGRM6OPE06P064DV", "report": "{\"id\":\"7db089a07a2d4f458c596ece1d27ebaf\",\"created\":1678983186897,\"userDataByProvider\":[{\"providerName\":\"oauth2\",\"updated\":1678983186243,\"financialInstitutionName\":\"BANK OF IRELAND (UK) PLC\",\"identity\":{},\"accounts\":[{\"id\":\"792a73c468c844f7b29336694f96611e\",\"accountNumber\":\"90212729823529\",\"currencyCode\":\"GBP\",\"name\":\"J Hetfield\",\"holderName\":\"J Hetfield\",\"accountIdentifiers\":{\"bacs\":{\"sortCode\":\"902127\",\"accountNumber\":\"29823529\"}},\"parties\":[{\"role\":\"HOLDER\",\"identity\":{\"name\":\"J Hetfield\"}}]}]}]}", "reference": null, "return_url" null, "client_bank_account_id": "OB0166YQRDJZWJVL656M", "account_validation_url": "https://testaccountvalidation.smarterpaycloud.com/?ID=AV016MQ0KN6XY6POXZG6", "message": null, "error_message": null, "successful_validation": false, "metadata_bank_account": null, "metadata_mandate": null } }