Get Consent Details

get https://test-openbanking.tbcbank.ge/0.8/v1/consents/{consentId}

Returns the content of an account information consent object.
This is returning the data for the TPP especially in cases,
where the consent was directly managed between ASPSP and PSU e.g. in a redirect SCA Approach.

Path Params

consentId

string

required

ID of the corresponding consent object as returned by an account information consent request.

Headers

X-Request-ID

uuid

required

ID of the request, unique to the call, as determined by the initiating party.

Digest

string

required

Is contained if and only if the "Signature" element is contained in the header of the request.

X-JWS-Signature

string

required

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

PSU-IP-Address

string

required

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Accept-Language

string

HTTP header indicates the natural language and locale that the client prefers.

PSU-IP-Port

string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Geo-Location

string

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response body

object

access

object

required

Requested access services for a consent.

accounts

array of objects

Is asking for detailed account information.

If the array is empty in a request, the TPP is asking for an accessible account list.
This may be restricted in a PSU/ASPSP authorization dialogue.
If the array is empty, also the arrays for balances, additionalInformation sub attributes or transactions shall be empty, if used.

accounts

object

iban

string

IBAN of an account

maskedPan

string

length ≤ 35

Masked Primary Account Number.

currency

string

ISO 4217 Alpha 3 currency code.

cashAccountType

string

ExternalCashAccountType1Code from ISO 20022.

CACC CARD

balances

array of objects

Is asking for balances of the addressed accounts.

If the array is empty in the request, the TPP is asking for the balances of all accessible account lists.
This may be restricted in a PSU/ASPSP authorization dialogue.
If the array is empty, also the arrays for accounts, additionalInformation sub attributes or transactions shall be empty, if used.

balances

object

iban

string

IBAN of an account

maskedPan

string

length ≤ 35

Masked Primary Account Number.

currency

string

ISO 4217 Alpha 3 currency code.

cashAccountType

string

ExternalCashAccountType1Code from ISO 20022.

CACC CARD

transactions

array of objects

Is asking for transactions of the addressed accounts.

If the array is empty in the request, the TPP is asking for the transactions of all accessible account lists.
This may be restricted in a PSU/ASPSP authorization dialogue.
If the array is empty, also the arrays for accounts, additionalInformation sub attributes or balances shall be empty, if used.

transactions

object

iban

string

IBAN of an account

maskedPan

string

length ≤ 35

Masked Primary Account Number.

currency

string

ISO 4217 Alpha 3 currency code.

cashAccountType

string

ExternalCashAccountType1Code from ISO 20022.

CACC CARD

availableAccounts

string

Optional if supported by API provider.

The values "allAccounts" and "allAccountsWithOwnerName" are admitted.
The support of the "allAccountsWithOwnerName" value by the ASPSP is optional.

allAccounts allAccountsWithOwnerName

availableAccountsWithBalance

string

Optional if supported by API provider.

The values "allAccounts" and "allAccountsWithOwnerName" are admitted.
The support of the "allAccountsWithOwnerName" value by the ASPSP is optional.

allAccounts allAccountsWithOwnerName

additionalInformation

object

Is asking for additional information as added within this structured object.
The usage of this data element requires at least one of the entries "accounts",
"transactions" or "balances" also to be contained in the object.
If detailed accounts are referenced, it is required in addition that any account addressed within
the additionalInformation attribute is also addressed by at least one of the attributes "accounts",
"transactions" or "balances".

recurringIndicator

boolean

required

"true", if the consent is for recurring access to the account data. "false", if the consent is for one access to the account data.

validUntil

date

required

This parameter is defining a valid until date (including the mentioned date) for the requested consent.

Max value for this field is 90 days.
If date is provided more than 90 days, it will be decreased to 90 days.
Less than 90 days, will remain same as provided date.

frequencyPerDay

int32

required

This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1". The frequency needs to be greater equal to one. If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4.

lastActionDate

date

required

This date is containing the date of the last action on the consent object either through the XS2A interface or the PSU/ASPSP interface having an impact on the status.

consentStatus

string

required

This is the overall lifecycle status of the consent.
Valid values are:

'received': The consent data have been received and are technically correct.
The data is not authorised yet.
'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.
'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.
'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.
'expired': The consent expired.
'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.

received rejected valid revokedByPsu expired terminatedByTpp

_links

object

A list of hyperlinks to be recognised by the TPP.

Links of type "account" and/or "cardAccount", depending on the nature of the consent.

account

object

Link to a resource.

cardAccount

object

Link to a resource.

Headers

object

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://test-openbanking.tbcbank.ge/0.8/v1/consents/consentId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK

400Bad Request

401Unauthorized

403Forbidden

500Server Error