Get Restore States

This endpoint returns all enumerated restore state values supported by the Netevia Banking API. Each restore state represents a possible status that a financial account or payment card can be transitioned to when it is being restored from a suspended or closed condition. Use this endpoint to populate dropdowns, validate inputs, or display human-readable labels alongside restore state codes in your application.

Endpoint

GET /api/enums/restoreStates

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Call this endpoint before performing any account or card restore operation to retrieve the current set of valid restore state codes. It is also useful when building administrative dashboards or status management workflows that need to display or validate restore state transitions. Because the list of supported states may evolve, fetching it dynamically rather than hardcoding values is strongly recommended.

Response

200 OK

Returns an array of code-description objects representing each valid restore state.

[
  {
    "code": "ACTIVE",
    "description": "Account or card restored to active status"
  },
  {
    "code": "SUSPENDED",
    "description": "Account or card in a suspended state pending review"
  },
  {
    "code": "CLOSED",
    "description": "Account or card permanently closed"
  }
]

Error Codes

Common Mistakes

• Hardcoding restore state codes in your integration instead of fetching them dynamically — the available states may change and hardcoded values will become stale.
• Not refreshing the Bearer token before calling this endpoint — tokens expire after 10 minutes and an expired token returns a 401 error.

Related Endpoints

• GET /api/enums/cardStatuses — Returns all valid card status codes and descriptions
• GET /api/enums/accountStatuses — Returns all valid financial account status codes and descriptions
• PUT /api/accounts/{accountId}/restore — Restores a financial account using a valid restore state code

Example

curl -X GET https://api.banking.netevia.dev/api/enums/restoreStates \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"