DELETE /v1/oauth2/tokens/{token}

Overview

This endpoint takes an access token and revokes it.

Note: Payment tokens cannot be revoked.

https://sandbox.konsentus.com/v1/oauth2/tokens/{token}

Request Properties

Headers

Authorization REQUIRED
string
Basic Auth Header
fi_reference_id REQUIRED
string
A string representing the FI authenticating with the system
version REQUIRED
string
A string representing version of the API you are using
eidas REQUIRED
string
Base64 encoded eIDAS certificate

Further information is available on Authentication Headers, eIDAS Certificates and Version Header.

Path Parameters

token REQUIRED
string
Unique Id of the token, generated by Konsentus, that is to be deleted.

Response Properties

token string
The access token generated by Konsentus.
auth_code string
The auth code generated by Konsentus.
created_time string
Creation date of the token.
updated_time string
Updated date of the token.
deleted_time string
Deleted date of the token.
account_id string
User account_id for the OAuth 2.0 client that requested this token.
psp_id string
Client identifier/PSP id for the OAuth 2.0 client that requested this token.
fi_id string
fi_id for the OAuth 2.0 client that requested this token.
redirect_uri string
Valid preregistered redirect URI.
scope string
Scope associated with this token can be either 'payments' or 'accounts'.
active boolean
Boolean indicator of whether or not the presented token is currently active.
errors array<object>

        See error documentation for fields and descriptions

Responses

200

If token was valid and has been revoked, expired, or was previously revoked.

{
  "token": string,
  "auth_code": string,
  "created_time": string,
  "deleted_time": string,
  "updated_time": string,
  "account_id": string,
  "psp_id": string,
  "fi_id": string,
  "redirect_uri": string,
  "scope": string,
  "active": boolean
}

400

Request received missing parameters or malformed.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

401

Unable to authorize.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

403

Revoke forbidden if token passed cannot be revoked.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

404

Token not found.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

Response Example

200 OK

{
  data: {
    "token": 'revoked-access-token',
    "active": false,
    "psp_id": "PSDGB-FCA-kt-484347",
    "account_id": "12345678",
    "scope": "accounts",
    "exp": 1588930925,
    "iat": 1494236525,
    "revoked_at": 1588930925
  }
}
Last Updated: 8/22/2019, 2:41:03 PM