Read details about a card account

get https://test-api.tbcbank.ge/xs2a-sandbox/v1/card-accounts/{cardAccountId}

Reads details about a card account. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends then on the stored consent addressed by consentId, respectively the OAuth2 access token.

Path Params

cardAccountId

string

required

This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Query Params

withBalance

boolean

filters result data with/without balance

Headers

X-Request-ID

string

required

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

Consent-ID

string

required

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest

string

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

Signature

string

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

PSU-IP-Address

string

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

Accept-Language

string

PSU Language. If this header is defined, result will be returned in proper language. The default language is Georgian.

Responses

Response body

object

cardAccount

object

resourceId

string | null

This is the data element to be used in the path when retrieving data from a dedicated account. This shall be filled, if addressable resource are created by the ASPSP on the /card-accounts endpoint.

maskedPan

string | null

Masked Primary Account Number.

currency

string | null

currencyCode

ownerName

string | null

Name of the legal account owner. If there is more than one owner, then e.g. two names might be noted here.

For a corporate account, the corporate name is used for this attribute. Even if supported by the ASPSP, the provision of this field might depend on the fact whether an explicit consent to this specific additional account information has been given by the PSU.

name

string | null

Name of the account, as assigned by the ASPSP, in agreement with the account owner in order to provide an additional means of identification of the account.

displayName

string | null

Name of the account as defined by the PSU within online channels.

product

string | null

Product Name of the Bank for this account, proprietary definition.

status

string | null

accountStatus

Account status. The value is one of the following:
• "enabled": account is available
• "deleted": account is terminated
• "blocked": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.

usage

string | null

Specifies the usage of the account:

• PRIV: private personal account

• ORGA: professional account

details

string | null

Specifications that might be provided by the ASPSP:

• characteristics of the account

• characteristics of the relevant card

creditLimit

string | null

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.

balances

array of objects | null

A list of balances regarding this account, e.g. the current balance, the last booked balance. The list might be restricted to the current balance.

balances

object

balanceType

string | null

The following balance types are defined:

• "closingBooked": Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.
• "expected": Balance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.
• "openingBooked": Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.
• "interimAvailable": Available balance calculated in the course of the account ?servicer?s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
• "interimBooked": Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
• "forwardAvailable": Forward available balance of money that is at the disposal of the account owner on the date specified.
• "nonInvoiced": Only for card accounts, to be checked yet.
•

balanceAmount

object

creditLimitIncluded

boolean | null

A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.

lastCommittedTransaction

string | null

"entryReference" of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known.

referenceDate

string | null

Indicates the date of the balance.

lastChangeDateTime

date-time | null

This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked.

links

object

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://test-api.tbcbank.ge/xs2a-sandbox/v1/card-accounts/ \
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

200Success

400Bad Request

401Unauthorized

404Not Found

500Server Error