Account State (enabled/disabled) Service

Available methods:

GET /v1/api/accounts/{accountID}/state

This method gets current state for the specified account.

Input Parameters

#ParameterParameter TypeData TypeMandatoryDescription/Valid Values
1 accountID path string Required

Identifies the account

Output Parameters

StateV1Model

StateV1Model { state (string): The account state = ['enabled', 'disabled'] }

Response Class (Status 200)

The account state was successfully found.

Response example

The current state of the account is displayed:

Response Body example{ "state": "disabled" }

Possible error response messages

POST /v1/api/accounts/{accountID}/state

The method changes the account state.

Input Parameters

 ParameterParameter TypeData TypeMandatoryDescription/Valid Values
1 accountID path

string

Required

Identifies the account

2 state body StateV1Model Required

The account state

Output Parameters

Inline Model {}

Response Class (Status 202)

The account change state request was successfully accepted.

Request example

New account state is specified:

Request Body example state { "state": "disabled" }

Possible error response messages