Client bank account records are where the client owners bank account records are stored. These are the bank account records that are lodged against a service user number or SUN.
| Method | Purpose |
|---|---|
| GET (Singular) | Get a single client bank account record |
| GET (List) | Get list of all client bank account records |
| GET (By SUN) | Get the default client bank account via a SUN number |
Action: Get a single client bank account record.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/clientbankaccount/{ID}
{ID} denotes ID of record.
Response Parameters
| Property | Description |
|---|---|
| Account_Number | Masked account number |
| Bank_Name | Bank name that the account is registered to |
| Default_Account | Boolean value, if true this is the default account that is registered to the service user number ( SUN ) |
| Friendly_Name | Friendly name of the client bank account record, this is to aid in identifying accounts |
| ID | Unique reference for this client bank account record |
| Sort_Code | Masked sort code of this client bank account record |
| SUN | Service User Number that this client bank account is attached to |
| Sun_Friendly_Name | A friendly name that is attached to this sun, this is to aid in identifying accounts |
Response Sample
{
"Client_Bank_Accounts":
{
"Account_Number": "*****102",
"Bank_Name": "Natwest",
"Default_Account": false,
"Friendly_Name": "Test SUn 1",
"ID": "CBA-0000001",
"Sort_Code": "****56",
"Sun": "122",
"Sun_Friendly_Name": "tes1"
}
}
Action: Get list of all client bank account records.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/clientbankaccount
Response Parameters
| Property | Description |
|---|---|
| Account_Number | Masked account number |
| Bank_Name | Bank name that the account is registered to |
| Default_Account | Boolean value, if true this is the default account that is registered to the service user number ( SUN ) |
| Friendly_Name | Friendly name of the client bank account record, this is to aid in identifying accounts |
| ID | Unique reference for this client bank account record |
| Sort_Code | Masked sort code of this client bank account record |
| SUN | Service User Number that this client bank account is attached to |
| Sun_Friendly_Name | A friendly name that is attached to this sun, this is to aid in identifying accounts |
Response Sample
{
"Client_Bank_Accounts": [
{
"Account_Number": "*****102",
"Bank_Name": "Natwest",
"Default_Account": false,
"Friendly_Name": "Test SUn 1",
"ID": "CBA-0000001",
"Sort_Code": "****56",
"Sun": "122",
"Sun_Friendly_Name": "tes1"
},
{
"Account_Number": "*****22",
"Bank_Name": "Barclays",
"Default_Account": true,
"Friendly_Name": "bg2",
"ID": "CBA-0000002",
"Sort_Code": "****21",
"Sun": "123",
"Sun_Friendly_Name": "test"
}
]
}
Action: Get the default client bank account via a SUN number.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/clientbankaccount/sun/{sun-number}
{sun-number} denotes the SUN number of the SUN, for example “123456”.
Response Parameters
| Property | Description |
|---|---|
| Account_Number | Masked account number |
| Bank_Name | Bank name that the account is registered to |
| Default_Account | Boolean value, if true this is the default account that is registered to the service user number ( SUN ) |
| Friendly_Name | Friendly name of the client bank account record, this is to aid in identifying accounts |
| ID | Unique reference for this client bank account record |
| Sort_Code | Masked sort code of this client bank account record |
| SUN | Service User Number that this client bank account is attached to |
| Sun_Friendly_Name | A friendly name that is attached to this sun, this is to aid in identifying accounts |
Response Sample
{
"Client_Bank_Accounts":
{
"Account_Number": "*****102",
"Bank_Name": "Natwest",
"Default_Account": false,
"Friendly_Name": "Test SUn 1",
"ID": "CBA-0000001",
"Sort_Code": "****56",
"Sun": "122",
"Sun_Friendly_Name": "tes1"
}
}