A Service User Number(SUN) is a unique identifier for organisations collecting payment by Direct Debit.
All communications with Bacs require a SUN.
Method | Purpose |
---|---|
GET (Singular) | Get a single Service User Number (SUN) record |
GET (List) | Get list of all Service User Numbers (SUNs) |
Action: Get a single Service User Number (SUN) record.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/serviceusernumber/{ID}
{ID} denotes ID of record.
Response Parameters
Property | Description |
---|---|
Default_Sun | Boolean value, is this the default sun |
SUN | Service User Number |
Sun_Friendly_Name | A friendly name attached to the sun record to help aid in identifying between multiple suns |
active | Boolean value, if the sun is active or not |
Response Sample
{ "Service_User_Number": { "Default_Sun": false, "SUN": "122", "Sun_Friendly_Name": "tes1", "active": true } }
Action: Get list of all Service User Numbers (SUNs).
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/serviceusernumber
Response Parameters
Property | Description |
---|---|
Default_Sun | Boolean value, is this the default sun |
SUN | Service User Number |
Sun_Friendly_Name | A friendly name attached to the sun record to help aid in identifying between multiple suns |
active | Boolean value, if the sun is active or not |
Response Sample
{ "Service_User_Number": [ { "Default_Sun": false, "SUN": "122", "Sun_Friendly_Name": "tes1", "active": true }, { "Default_Sun": true, "SUN": "123", "Sun_Friendly_Name": "test", "active": true } ] }