/status
/status
Target audience: Developers
Introduction
This endpoint returns the status of an account. The account status indicates if the account should be eligible for using services. Possible values are:
Status |
"created" |
"active" |
"inactive" |
"archived" |
URI
Environment |
URI |
Stage |
https://payway-api.stage.adeprimo.se/external/api/v1/accounts/status |
Production |
https://backend.worldoftulo.com/external/api/v1/accounts/status |
Required scope
Parameters
Name |
Required |
Type |
Description |
id |
Optional |
String |
The id of the account to get information about. Size range: ..24 Allowed values: "/^[a-f\d]{24}$/i" |
email |
Optional |
String |
The email of the account to get information about. Size range: ..1024 Allowed values: "/\A[\w+-.]+@[a-z\d-]+(.[a-z]+)*.[a-z]+\z/i" |
Curl Example
Email
| curl --request GET \
--url https://payway-api.stage.adeprimo.se/external/api/v1/accounts/status?email=test@example.com \
--header 'accept: application/json' \
--header 'authorization: Bearer <token>'
|
Response
Example response
| HTTP 200
{
"item":
{
"status": "active"
}
}
|
Errors
Example error response
| HTTP 400 Bad Request
{
"code": "invalid_parameter",
"field": "email",
"message": "Parameter must match format /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i"
}
|
HTTP 400 Bad Request
Name |
Type |
Description |
unknown_parameter |
Object |
One or more of the fields in the posted json was not recognized |
invalid_parameter |
Object |
Only one of [id, email] is allowed |
invalid_parameter |
Object |
One of parameters [id, email] is required |
HTTP 404 Not Found
Name |
Type |
Description |
not_found |
Object |
The account could not be found |
HTTP 500 Internal Server Error
Name |
Type |
Description |
internal_server_error |
Object |
Something unexpected happened server side |