Create Account
Specifications
Request
| JSON PATH | Description | Example | Format | Required |
|---|---|---|---|---|
| client_id | Identifier associated to you | 3d0229b5-8330-4c62-be60-d8a5ba2f605d | UUID | No |
| account_profile_id | The Identifier associated to Account Profile | 516ed7e6-ced5-44f1-b4f2-6878bc33be58 | UUID | Yes |
| account_name | The name of the Account if required. If provided, CLOWD9 will include this value in Account Reports and Vista displays | CLOWD9 Expenses | string | No |
| account_status | Default is inactive and until set to active, all Account activity will be restricted | inactive | string | No |
| behaviour_id | The Identifier of the Behaviour to be associated with the account_id | 0c84b219-6b5a-4296-85db-e3b5bbcdca52 | UUID | No |
Question - should we make it mandatory for customer_id to be linked to the account?
Successful Response
| JSON PATH | Description | Example | Format | Required |
|---|---|---|---|---|
| account_profile_id | The Identifier associated to Account Profile | 516ed7e6-ced5-44f1-b4f2-6878bc33be58 | UUID | Yes |
| account_id | The Identifier associated to the newly create account_id. This is generated by CLOWD9 | 62f5ffd5-ba38-4162-8f4d-54e5f40f3964 | string | No |
| trace_id | The Identifier of the Behaviour to be associated with the account_id | 1276d082-4f1c-4852-89c9-0ffe980702da | UUID | No |
Unsuccessful
| JSON PATH | Description | Format | Sample/Example | Required |
|---|---|---|---|---|
| account_id | The Identifier associated to the Account | UUID | fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4 | Yes |
| reason | The reason why the request has not been successful. For example: exceeds daily limit exceeds maximum balance insufficient balance | string | exceeds daily limit | Yes |
| trace_id | The Identifier associated with the API | UUID | 15bfc289-de75-4668-bb11-3998aadf226d | Yes |
Updated 14 days ago