POST /v1/obie/ccg_tokens

Overview

This endpoint creates a client credentials grant token to be given to the requesting PSP by the FI to create consents resources.

https://sandbox.konsentus.com/v1/obie/ccg_tokens

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
Content-Type REQUIRED
string
Must be set to: application/json

Further information is available on Authentication Headers and Version Header.

Request Body Properties

eIDAS REQUIRED
object
An eIDAS Certificate
scope REQUIRED
object
The scope requested by the PSP for access to the PSU’s details from the FI.

Further information is available on eIDAS Certificates.

Request Body Example

{
  "eIDAS": `
  MIIElDCCA3ygAwIBAgIJAIX2W+2EDxehMA0GCSqGSIb3DQEBBQUAMEQxCzAJBgNVBAYTAkZSMQswCQYD
  VQQIEwJGUjETMBEGA1UEChMKQ2VydEV1cm9wZTETMBEGA1UEAxMKQ2VydEV1cm9wZTAeFw0xOTAyMTkx
  NTIyMDdaFw0yMDAyMTkxNTIyMDdaMIGFMQswCQYDVQQGEwJHQjErMCkGA1UECgwiS29uc2VudHVzIFBh
  eW1lbnQgU2VydmljZXMgTGltaXRlZDErMCkGA1UEAwwiS29uc2VudHVzIFBheW1lbnQgU2VydmljZXMg
  TGltaXRlZDEcMBoGA1UEYQwTUFNER0ItRkNBLWt0LTQ4NDM0NzCCASIwDQYJKoZIhvcNAQEBBQADggEP
  ADCCAQoCggEBAMoLgXDQ+nditYb2tTwxtDnDk5sOPIJyHgeN6omgcOmbmad9+b9PPknWcCdNuyruv0ke
  Iv5A8592j8IxIzF3RaNH0OE+SLzFMuAz2xRbA2BrD6q1XPcML5H4lkmEuYGuH+Xtv9zIaTtPQxapQmru
  UPDHD3+9MjmyyHpkyrRnqQ2JG+df7CEeD9eN53DU7B4u2MgXiibQcyWk2dk+KpGSIssOZA5+aetWs29a
  D6BJUUOt492UeLIMZAtlGZzF+I5ASMiXzL4wnUSOOLmSfTIsSVm7ChebZe6b7PuY/k3kBw2rrTNhHGWq
  YPpyzkri9lPhtICe/12r8Mze3UIOZ3QHghMCAwEAAaOCAUUwggFBMAkGA1UdEwQCMAAwHQYDVR0OBBYE
  FB2DbT6Y4KSVWTsDRIaIet6L0XCCMB8GA1UdIwQYMBaAFNINLe/phgwefLhOutKprennyA1PMAkGA1Ud
  EQQCMAAwUgYDVR0fBEswSTBHoEWgQ4ZBaHR0cHM6Ly9zMy5ldS13ZXN0LTIuYW1hem9uYXdzLmNvbS9r
  LWNlcnRzL2t0LXN1Y2Nlc3Mtam91cm5leS5jcmwwgYcGCCsGAQUFBwEBBHsweTAlBggrBgEFBQcwAYYZ
  aHR0cDovL29jc3Aua29uc2VudHVzLmNvbTBQBggrBgEFBQcwAoZEaHR0cHM6Ly9zMy5ldS13ZXN0LTIu
  YW1hem9uYXdzLmNvbS9rLWNlcnRzL2t0LXN1Y2Nlc3Mtam91cm5leS1jYS5kZXIwCwYDVR0PBAQDAgTw
  MA0GCSqGSIb3DQEBBQUAA4IBAQAFrsonr/NNN2Hl9EBB+aAhB3exNnDXCOM8eqoDnwTA3A5Nyj5gXq2c
  y5s8S2CjAodj9yG3ZQdAxN/MVlZ909cmZC87M87KGw0x1LkfF5M65nMz5ynx6NeCASO0uqNkt4yKrT6E
  Duq7E8hoFteYQ6z4xMKX3NZ2KzIE8EWxuHOYPSjEbCeYea4ACTThOlPeFgWFMTs/oRXMkDRTcFcWthEa
  UKiFRJsqGMKZNp++q9gOAcB84H6+PekbieZKHxNEXTiFIwKMhCQ/FI8kwhdJxq8iBRc++fCkZ/HfS0ez
  YQoUaCfGckZpS6HK8TKP/HHNe/TCxS1xFVkO1k8cNK5ZFjQp`,
  "scope": "accounts"
}

Response Properties

psp_id string
An id for a PSP matching the unique identifier they are registered with on the CA.
access_token string
The access token generated by Konsentus to be used to make later requests for consents resources
expires_in integer
If the access token expires, the server replies with the duration of time (seconds) the access token is granted for.
token_type string
The type of token is typically just the string 'bearer'.
scope string
The scope of the client credentials grant token, should set to 'payments' or 'accounts'.
payment_service_number number
The payment service number associated with this token and PSP, should be set to 7 (Payment Initiation Services) or 8 (Account Information Services ).
active boolean
A boolean value indicating whether or not the token is active.
warning string (optional)
A warning is returned when the PSP does not have role in their NCA register that matches the requested scope.
errors array<object>

        See error documentation for fields and descriptions

Responses

201

Request received, client credentials grant token created.

{
    "psp_id": string,
    "access_token": string,
    "expires_in": integer,
    "token_type": string,
    "scope": string,
    "payment_service_number": number,
    "active": boolean,
    "warning": string
  }

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
  }]
}

Response Example

201 CREATED

Success:

{
  "psp_id": "PSDGB-FCA-kt-484347",
  "access_token": "11223344-7174-4946-a46b-e4811dc66e0d",
  "expires_in": 31104000,
  "token_type": "bearer",
  "scope": "accounts",
  "payment_service_number": 8,
  "active": true
}

201 CREATED

Success with warning:

{
  "psp_id": "PSDGB-FCA-kt-484347",
  "access_token": "11223344-7174-4946-a46b-e4811dc66e0d",
  "expires_in": 31104000,
  "token_type": "bearer",
  "scope": "accounts",
  "payment_service_number": 8,
  "active": true,
  "warning": "PSP does not have payment service in their NCA register that matches the requested scope"
}
Last Updated: 8/9/2019, 3:47:34 PM