Account Status
When an Account is created, the default status is inactive restricting any activity outside of changing the status; you can set this to active at creation stage using the Create Account API.
In most cases, during the Account Lifecycle, the status will not require any changes; however there may be times when the status is to be updated. The following status values can apply:
- inactive: Default value which is applied by CLOWD9. Once the Account status has been changed from inactive, this can never be reverted to this status. All activity is restricted under this status and restricts all activity to the Account such as:
- Balance updates
- Use of any card_id and or dpan_ids that the Customer may have i.e. authorizations will be declined
- active: The Account can set to active during the create stage or at a later date using the Set Account Status API. All activity will be permitted
- administrative: A temporary block to restrict all activity on the Account pending the outcome of any investigation. Post investigations the Account should be returned to active, fraud or closed
- fraud: A permanent status which is to be used where the Account and / or associated payment devices have had fraudulent activity. A new Account will need to be created
- closed: In the event of the Customer requiring to close their Account, once remaining funds have been removed from the Account balance and all relevant actions completed in line with your procedures, the Account should be set to closed
CLOWD9 will return any requests where the new status is equal to the existing status, for example changing from active to active.
Specifications
Request
JSON PATH | Description | Example | Format | Required |
---|---|---|---|---|
account_id | Identifier associated to the Account | 3d0229b5-8330-4c62-be60-d8a5ba2f605d | UUID | Yes |
account_status | Default is inactive and until set to active, all Account activity will be restricted | active | string | Yes |
Succesful Response
JSON PATH | Description | Example | Format |
---|---|---|---|
account_id | Identifier associated to the Account | 3d0229b5-8330-4c62-be60-d8a5ba2f605d | UUID |
previous_account_status | Previous status of the Account | inactive | string |
new_account_status | New status of the Account | active | string |
trace_id | The Identifier associated with the API | 663bd8a4-6dfa-4ec2-b269-fedc0743f1dd | UUID |
Updated 14 days ago