Read transaction list of an account

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

Read transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances.

For a given account, additional parameters are e.g.the attributes "dateFrom" and "dateTo". The ASPSP might add balance information, if transaction lists without balances are not supported.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

accountId

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

DateFrom

date-time

Conditional: Starting date (inclusive the date dateFrom) of the transaction list.

For booked transactions, the relevant date is the booking date.
For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.

DateTo

date-time

End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.

BookingStatus

int32

Permitted codes are

"booked",
"pending" and
"both".
"booked" shall be supported by the ASPSP.To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked".
Available values : booked, pending, both

Values:

0 - booked
1 - pending
2 - both

WithBalance

boolean

If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

EntryReferenceFrom

string

This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period.

Optional if supported by API provider.

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

account

object

iban

string | null

IBAN of an account

bban

string | null

Basic Bank Account Number (BBAN) Identifier.

This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).

Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.

pan

string | null

Primary Account Number according to ISO/IEC 7812.

maskedPan

string | null

Masked Primary Account Number.

msisdn

string | null

Mobile phone number.

currency

string | null

ISO 4217 Alpha 3 currency code.

other

object

balances

array of objects | null

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.

transactions

object

JSON based account report. This account report contains transactions resulting from the query parameters.
'booked' shall be contained if bookingStatus parameter is set to "booked" or "both".
'pending' is not contained if the bookingStatus parameter is set to "booked" or "information".
'information' Only contained if the bookingStatus is set to "information" and if supported by ASPSP.

booked

array of objects | null

Array of transaction details.

booked

object

transactionId

string | null

example: 3dc3d5b3-7023-4848-9853-f5400a64e80f
This identification is given by the attribute transactionId of the corresponding entry of a transaction list.

entryReference

string | null

Is the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages.

endToEndId

string | null

Unique end to end identity.

mandateId

string | null

Identification of Mandates, e.g. a SEPA Mandate ID.

creditorId

string | null

example: Creditor Id 5678
Identification of Creditors, e.g.a SEPA Creditor ID.

creditorName

string | null

example: Creditor Name
Creditor name.

creditorAccount

object

creditorAgent

string | null

pattern: [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
example: AAAADEBBXXX

creditorIdentification

object

debtorName

string | null

example: Debtor Name
Debtor Name

debtorAccount

object

debtorAgent

string | null

Debtor Agent
example: AAAADEBBXXX

debtorIdentification

object

ultimateDebtor

string | null

example: Ultimate Debtor
Ultimate debtor.

ultimateDebtorIdentification

object

transactionAmount

object

bookingDate

string | null

The date when an entry is posted to an account on the ASPSPs books.

valueDate

string | null

The Date at which assets become available to the account owner in case of a credit, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

remittanceInformationUnstructured

string | null

example: Ref Number Merchant
Unstructured remittance information.

remittanceInformationStructured

string | null

Structured remittance information Max

remittanceInformationUnstructuredArary

array of strings | null

example: List [ "Ref Number Merchant", "Some Other Text" ]
Array of unstructured remittance information.

remittanceInformationUnstructuredArary

additionalInformation

string | null

example: Some additional transaction related information.
Might be used by the ASPSP to transport additional transaction related information to the PSU

purposeCode

string | null

ExternalPurpose1Code from ISO 20022.
Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.

bankTransactionCode

string | null

Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.

currencyExchange

array of objects | null

Array of exchange rates.

currencyExchange

object

sourceCurrency

string | null

Source Currency

exchangeRate

string | null

Exchange Rate

unitCurrency

string | null

Unit Currency

targetCurrency

string | null

Target Currency

quotationDate

string | null

Quotation Date

contractIdentification

string | null

Contract Identification

proprietaryBankTransactionCode

string | null

Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.

balanceAfterTransaction

object

A single balance element.

pending

array of objects | null

Array of transaction details.

pending

object

transactionId

string | null

example: 3dc3d5b3-7023-4848-9853-f5400a64e80f
This identification is given by the attribute transactionId of the corresponding entry of a transaction list.

entryReference

string | null

Is the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages.

endToEndId

string | null

Unique end to end identity.

mandateId

string | null

Identification of Mandates, e.g. a SEPA Mandate ID.

creditorId

string | null

example: Creditor Id 5678
Identification of Creditors, e.g.a SEPA Creditor ID.

creditorName

string | null

example: Creditor Name
Creditor name.

creditorAccount

object

creditorAgent

string | null

pattern: [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
example: AAAADEBBXXX

creditorIdentification

object

debtorName

string | null

example: Debtor Name
Debtor Name

debtorAccount

object

debtorAgent

string | null

Debtor Agent
example: AAAADEBBXXX

debtorIdentification

object

ultimateDebtor

string | null

example: Ultimate Debtor
Ultimate debtor.

ultimateDebtorIdentification

object

transactionAmount

object

bookingDate

string | null

The date when an entry is posted to an account on the ASPSPs books.

valueDate

string | null

remittanceInformationUnstructured

string | null

example: Ref Number Merchant
Unstructured remittance information.

remittanceInformationStructured

string | null

Structured remittance information Max

remittanceInformationUnstructuredArary

array of strings | null

example: List [ "Ref Number Merchant", "Some Other Text" ]
Array of unstructured remittance information.

remittanceInformationUnstructuredArary

additionalInformation

string | null

example: Some additional transaction related information.
Might be used by the ASPSP to transport additional transaction related information to the PSU

purposeCode

string | null

ExternalPurpose1Code from ISO 20022.
Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.

bankTransactionCode

string | null

Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.

currencyExchange

array of objects | null

Array of exchange rates.

currencyExchange

object

sourceCurrency

string | null

Source Currency

exchangeRate

string | null

Exchange Rate

unitCurrency

string | null

Unit Currency

targetCurrency

string | null

Target Currency

quotationDate

string | null

Quotation Date

contractIdentification

string | null

Contract Identification

proprietaryBankTransactionCode

string | null

Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.

balanceAfterTransaction

object

A single balance element.

links

object

links

object

download

object

Language

Credentials

Bearer

URL


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