AISP

get/accounts/{accountResourceId}/transactions

Retrieval of an account transaction set (AISP)

OAuth2 scopes: aisp, aisp

Description

This call returns transactions for an account for a given PSU account that is specified by the AISP through an account resource identification. The request may use some filter parameter in order to restrict the query

on a given imputation date range
past a given incremental technical identification

The result may be subject to pagination (i.e. retrieving a partial result in case of having too many results) through a set of pages by the ASPSP. Thereafter, the AISP may ask for the first, next, previous or last page of results.

Prerequisites

The TPP has been registered by the Registration Authority for the AISP role
The TPP and the PSU have a contract that has been enrolled by the ASPSP
- At this step, the ASPSP has delivered an OAUTH2 "Authorization Code" or "Resource Owner Password" access token to the TPP (cf. Â§ 3.4.2). The TPP and the ASPSP have successfully processed a mutual check and authentication
The TPP has presented its OAUTH2 "Authorization Code" or "Resource Owner Password" access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. Â§ 3.4.2) is any.
The ASPSP takes into account the access token that establishes the link between the PSU and the AISP.
The TPP has previously retrieved the list of available accounts for the PSU

Business flow

The AISP requests the ASPSP on one of the PSUâ€™s accounts. It may specify some selection criteria. The ASPSP answers by a set of transactions that matches the query. The result may be subject to pagination in order to avoid an excessive result set.

Parameters (20)

Authorizationheaderstringrequired
Access token to be passed as a header
accountResourceIdpathstringrequired
Identification of account resource to fetch
Constraints: pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,35})$
dateFromquerystring
Inclusive minimal imputation date of the transactions.

Transactions having an imputation date equal to this parameter are included within the result.
dateToquerystring
Exclusive maximal imputation date of the transactions.

Transactions having an imputation date equal to this parameter are not included within the result.
afterEntryReferencequerystring
Specifies the value on which the result has to be computed.

Only the transaction having a technical identification greater than this value must be included within the result
Constraints: maxLength: 40
PSU-IP-Addressheaderstring
IP address used by the PSU's terminal when connecting to the TPP
PSU-IP-Portheaderstring
IP port used by the PSU's terminal when connecting to the TPP
PSU-HTTP-Methodheaderstring
Http method for the most relevant PSUâ€™s terminal request to the TTP
PSU-Dateheaderstring
Timestamp of the most relevant PSUâ€™s terminal request to the TTP
PSU-GEO-Locationheaderstring
Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP
PSU-User-Agentheaderstring
"User-Agent" header field sent by the PSU terminal when connecting to the TPP
PSU-Refererheaderstring
"Referer" header field sent by the PSU terminal when connecting to the TPP. Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood.
PSU-Acceptheaderstring
"Accept" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Charsetheaderstring
"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Encodingheaderstring
"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Languageheaderstring
"Accept-Language" header field sent by the PSU terminal when connecting to the TPP
PSU-Device-IDheaderstring
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of installation identification this ID need to be unaltered until removal from device.
Digestheaderstring
Digest of the body
Signatureheaderstringrequired
http-signature of the request (cf. https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate.
X-Request-IDheaderstringrequired
Correlation header to be set in a request and retrieved in the relevant response
Constraints: maxLength: 70

Responses

200

Complete transactions response

object

HalTransactions

HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP

Fields (2)

transactionsarray<Transaction>required
List of transactions
Item: Transaction
structure of a transaction
- resourceIdResourceId
  API: Identifier assigned by the ASPSP for further use of the created resource through API calls.
  Schema: ResourceId
  API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data.
  Type: string
  Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,35})$`
- entryReferencestring
  Technical incremental identification of the transaction.
  Technical incremental identification of the transaction.
  Constraints: maxLength: 40
- transactionAmountAmountTyperequired
  Structure aiming to embed the amount and the currency to be used.
  Schema: AmountType
  Structure aiming to embed the amount and the currency to be used.
  currencyCurrencyCodeISO 4217required
  Specifies the currency of the amount or of the account.
  Schema: CurrencyCode
  Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
  Type: string
  Constraints: pattern: `^[A-Z]{3,3}$`
  amountstringrequired
  ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
  ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
  Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
- creditDebitIndicatorCreditDebitIndicatorrequired
  Accounting flow of the amount
  Schema: CreditDebitIndicator
  Code
  CRDT
  DBIT
- statusTransactionStatusrequired
  Type of Transaction
  Schema: TransactionStatus
  Code
  BOOK
  PDNG
  OTHR
- bookingDatestring (date)ISO 8601required
  Booking date of the transaction on the account
  Booking date of the transaction on the account If the transaction is not yet booked. This field must be valued with a scheduled booking date.
- valueDatestring (date)ISO 8601
  Value date of the transaction on the account
- transactionDatestring (date)ISO 8601
  Date used for specific purposes:
  Date used for specific purposes:
  
  for card transaction: date of the transaction
  
  for credit transfer: acquiring date of the transaction
  
  for direct debit: receiving date of the transaction
- remittanceInformationUnstructuredRemittanceInformation
  ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
  Schema: UnstructuredRemittanceInformation
  Type: array<string>
  ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. API: Only one occurrence is allowed
  Item: Relevant information to the transaction
  Item constraints: maxLength: 140
_linksTransactionsLinksrequired
links that can be used for further navigation when browsing Account Information at one account level
Schema: TransactionsLinks
links that can be used for further navigation when browsing Account Information at one account level

self: link to the transactions of a given account

parent-list: link to the list of all available accounts

balances: link to the balances of a given account

first: link to the first page of the transactions result

last: link to the last page of the transactions result

next: link to the next page of the transactions result

prev: link to the previous page of the transactions result
- selfGenericLinkrequired
  hypertext reference
  Schema: GenericLink
  hypertext reference
  hrefstringrequired
  URI to be used
  Constraints: maxLength: 140
  templatedboolean
  specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- parent-listGenericLink
  hypertext reference
  Schema: GenericLink
  hypertext reference
  hrefstringrequired
  URI to be used
  Constraints: maxLength: 140
  templatedboolean
  specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- balancesGenericLink
  hypertext reference
  Schema: GenericLink
  hypertext reference
  hrefstringrequired
  URI to be used
  Constraints: maxLength: 140
  templatedboolean
  specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- firstGenericLink
  hypertext reference
  Schema: GenericLink
  hypertext reference
  hrefstringrequired
  URI to be used
  Constraints: maxLength: 140
  templatedboolean
  specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- lastGenericLink
  hypertext reference
  Schema: GenericLink
  hypertext reference
  hrefstringrequired
  URI to be used
  Constraints: maxLength: 140
  templatedboolean
  specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- nextGenericLink
  hypertext reference
  Schema: GenericLink
  hypertext reference
  hrefstringrequired
  URI to be used
  Constraints: maxLength: 140
  templatedboolean
  specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- prevGenericLink
  hypertext reference
  Schema: GenericLink
  hypertext reference
  hrefstringrequired
  URI to be used
  Constraints: maxLength: 140
  templatedboolean
  specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

204

No content.

Shared response definition: 204

400

Invalid status value

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

401

Unauthorized, authentication failure.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

403

Forbidden, authentication successful but access to resource is not allowed.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

404

Not found, no request available.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

405

Method Not Allowed.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

406

Not Acceptable.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

408

Request Timeout.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

429

Too many requests.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

500

Internal server error.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

503

Service unavailable.

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

Schemas used by this endpoint

Every structure referenced by this operation, listed once. Cross-references resolve to anchors on this page.

object

AmountType

Structure aiming to embed the amount and the currency to be used.

Fields (2)

currencyCurrencyCodeISO 4217required
Schema: CurrencyCode
amountstringrequired
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

string

CreditDebitIndicator

Accounting flow of the amount

CRDT: Credit type amount
DBIT: Debit type amount

Code
`CRDT`
`DBIT`

string

CurrencyCode

Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

object

ErrorModel

Generic error report structure

Fields (5)

timestampstring (date-time)ISO 8601
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140

object§ 4.1.4 · PDF p. 7

GenericLink

hypertext reference

Fields (2)

hrefstringrequired
URI to be used
Constraints: maxLength: 140
templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

object

HalTransactions

HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP

Fields (2)

transactionsarray<Transaction>required
List of transactions
Item: Transaction
_linksTransactionsLinksrequired
Schema: TransactionsLinks

string

ResourceId

API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data.

object

Transaction

structure of a transaction

Fields (9)

resourceIdResourceId
Schema: ResourceId
entryReferencestring
Technical incremental identification of the transaction.
Technical incremental identification of the transaction.
Constraints: maxLength: 40
transactionAmountAmountTyperequired
Schema: AmountType
creditDebitIndicatorCreditDebitIndicatorrequired
Schema: CreditDebitIndicator
statusTransactionStatusrequired
Schema: TransactionStatus
bookingDatestring (date)ISO 8601required
Booking date of the transaction on the account
Booking date of the transaction on the account If the transaction is not yet booked. This field must be valued with a scheduled booking date.
valueDatestring (date)ISO 8601
Value date of the transaction on the account
transactionDatestring (date)ISO 8601
Date used for specific purposes:
Date used for specific purposes:
- for card transaction: date of the transaction
- for credit transfer: acquiring date of the transaction
- for direct debit: receiving date of the transaction
remittanceInformationUnstructuredRemittanceInformation
Schema: UnstructuredRemittanceInformation

object

TransactionsLinks

links that can be used for further navigation when browsing Account Information at one account level

self: link to the transactions of a given account
parent-list: link to the list of all available accounts
balances: link to the balances of a given account
first: link to the first page of the transactions result
last: link to the last page of the transactions result
next: link to the next page of the transactions result
prev: link to the previous page of the transactions result

Fields (7)

selfGenericLinkrequired
Schema: GenericLink
parent-listGenericLink
Schema: GenericLink
balancesGenericLink
Schema: GenericLink
firstGenericLink
Schema: GenericLink
lastGenericLink
Schema: GenericLink
nextGenericLink
Schema: GenericLink
prevGenericLink
Schema: GenericLink

string

TransactionStatus

Type of Transaction

BOOK: (ISO20022 ClosingBooked) Accounted transaction
PDNG: (ISO20022 Expected) Instant Balance Transaction
OTHR: Other

Code
`BOOK`
`PDNG`
`OTHR`

array

UnstructuredRemittanceInformation

ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. API: Only one occurrence is allowed

Items: string