GET /v1/oauth2/tokens/{token}

Overview

This endpoint returns an access token including an active property which gives approval for the bank to pass the account information/payment.

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
The access token generated by Konsentus.

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

Request received, token data returned.

{
  "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
}

401

Unable to authorize

{
  "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

Request received, token data returned.

{
  "data": {
    "token": "832018ac-7174-4966-a46b-e4811dc66e0d",
    "auth_code": "406raajjhsxr20s",
    "created_time": "2021-05-29T16:11:46.650Z",
    "updated_time": "2018-06-05T09:22:18.384Z",
    "deleted_time": null,
    "account_id": "1",
    "psp_id": "PSDGB-FCA-kt-484347",
    "fi_id": "testFI",
    "redirect_uri": "https://www.google.com",
    "scope": "payments",
    "active": true
  }
}
Last Updated: 8/22/2019, 2:41:03 PM