Read transaction list of an account.
GET/api/v1/accounts/:account-id/transactions
Read transaction reports or transaction lists of a given account addressed 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.
Request
Path Parameters
This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call.
Query Parameters
- booked
- pending
- both
- information
- all
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.
Conditional: Starting date (inclusive the date dateFrom) of the transaction list,
mandated if no delta access is required and if bookingStatus does not equal "information".
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.
End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.
Might be ignored if a delta function is used.
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.
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. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
Optional if supported by API provider
Possible values: [booked, pending, both, information, all]
Permitted codes are
"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". To support the "information" feature is optional for the ASPSP. Currently the booking status “information” only covers standing orders. Error code if not supported. To support the "all" feature is optional for the ASPSP, Error code if not supported. If supported, "all" means to request transaction reports of transaction of any bookingStatus ("pending", "booked" or "information").
This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider
Header Parameters
- GET
- POST
- PUT
- PATCH
- DELETE
ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the OpenBankingGateway.Models.Accounts.AISRequestHeaders.Signature element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Possible values: Value must match regular expression \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
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.
TThe forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
Possible values: [GET, POST, PUT, PATCH, DELETE]
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
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 an installation identification this ID needs to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
Responses
- 200
- 401
- 403
Success
Response Headers
X-Request-ID
string
ID of the request, unique to the call, as determined by the initiating party.
- application/json
- Schema
- Example (from schema)
- Example 1.
Schema
-
IBAN, of a payment accounts, or
-
BBAN, for payment accounts if there is no IBAN, or
-
Not used by SDC the Primary Account Number(PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
-
Not used by SDC the Primary Account Number(PAN) of a card in a masked form, or
-
Not used by SDC an alias to access a payment account via a registered mobile phone number(MSISDN).
-
A payment account AccountReferenceOther when using a national payment Form.
Array [
-
IBAN, of a payment accounts, or
-
BBAN, for payment accounts if there is no IBAN, or
-
Not used by SDC the Primary Account Number(PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
-
Not used by SDC the Primary Account Number(PAN) of a card in a masked form, or
-
Not used by SDC an alias to access a payment account via a registered mobile phone number(MSISDN).
-
A payment account AccountReferenceOther when using a national payment Form.
-
IBAN, of a payment accounts, or
-
BBAN, for payment accounts if there is no IBAN, or
-
Not used by SDC the Primary Account Number(PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
-
Not used by SDC the Primary Account Number(PAN) of a card in a masked form, or
-
Not used by SDC an alias to access a payment account via a registered mobile phone number(MSISDN).
-
A payment account AccountReferenceOther when using a national payment Form.
- 1056
- 5768.2
- -1.50
- 5877.78
]
Array [
-
IBAN, of a payment accounts, or
-
BBAN, for payment accounts if there is no IBAN, or
-
Not used by SDC the Primary Account Number(PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
-
Not used by SDC the Primary Account Number(PAN) of a card in a masked form, or
-
Not used by SDC an alias to access a payment account via a registered mobile phone number(MSISDN).
-
A payment account AccountReferenceOther when using a national payment Form.
-
IBAN, of a payment accounts, or
-
BBAN, for payment accounts if there is no IBAN, or
-
Not used by SDC the Primary Account Number(PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
-
Not used by SDC the Primary Account Number(PAN) of a card in a masked form, or
-
Not used by SDC an alias to access a payment account via a registered mobile phone number(MSISDN).
-
A payment account AccountReferenceOther when using a national payment Form.
- 1056
- 5768.2
- -1.50
- 5877.78
]
account
object
Reference to an account by either
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
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
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other
object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type
(e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
transactions
object
booked
object[]
nullable
Array of transaction details.
The date when an entry is posted to an account on the ASPSPs books
This identification is given by the attribute transactionId of the corresponding entry of a transaction list.
Creditor name.
creditorAccount
object
Reference to an account by either
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
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
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other
object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type
(e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
debtorAccount
object
Reference to an account by either
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
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
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other
object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type
(e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
transactionAmount
object
Base Model for amount.
Possible values: non-empty, Value must match regular expression [A-Z]{3}
Currency Code.
Possible values: non-empty, Value must match regular expression -?[0-9]{1,14}(\.[0-9]{1,3})?
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.
Example Valid representations for EUR with up to two decimals are:
The Date at which assets become available to the account owner in case of a credit.
pending
object[]
nullable
Array of transaction details.
This identification is given by the attribute transactionId of the corresponding entry of a transaction list.
Creditor name.
creditorAccount
object
Reference to an account by either
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
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
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other
object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type
(e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
debtorAccount
object
Reference to an account by either
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
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
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other
object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type
(e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
transactionAmount
object
Base Model for amount.
Possible values: non-empty, Value must match regular expression [A-Z]{3}
Currency Code.
Possible values: non-empty, Value must match regular expression -?[0-9]{1,14}(\.[0-9]{1,3})?
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.
Example Valid representations for EUR with up to two decimals are:
The Date at which assets become available to the account owner in case of a credit.
{
"account": {
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
},
"transactions": {
"booked": [
{
"bookingDate": "string",
"transactionId": "string",
"creditorName": "string",
"creditorAccount": {
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
},
"debtorName": "string",
"debtorAccount": {
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
},
"transactionAmount": {
"currency": "EUR",
"amount": "5877.78"
},
"valueDate": "string"
}
],
"pending": [
{
"transactionId": "string",
"creditorName": "string",
"creditorAccount": {
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
},
"debtorName": "string",
"debtorAccount": {
"iban": "string",
"bban": "string",
"pan": "string",
"maskedPan": "string",
"msisdn": "string",
"other": {
"identification": "string",
"schemeNameCode": "string",
"schemeNameProprietary": "string",
"issuer": "string"
},
"currency": "EUR",
"cashAccountType": "string"
},
"transactionAmount": {
"currency": "EUR",
"amount": "5877.78"
},
"valueDate": "string"
}
]
}
}
{
"account": {
"iban": "AL4820511014241481CLPECFEUR0",
"bban": "401241481CLPECFEUR06",
"currency": "EUR"
},
"transactions": {
"booked": [
{
"bookingDate": "2017-10-25",
"transactionId": "eef6e2a0-2b46-4fa4-9f17-47d1d015d91c",
"creditorName": "John Smith",
"creditorAccount": {
"iban": "AL5920511014241481CLPECLALLA",
"bban": "401241481CLPECLALLAZ",
"currency": "ALL"
},
"transactionAmount": {
"currency": "EUR",
"amount": "250"
},
"valueDate": "2017-10-26"
},
{
"bookingDate": "2017-10-25",
"transactionId": "f106e8af-6448-4810-b62c-36c61aaf3e23",
"creditorAccount": {
"iban": "AL1020511014241481CLPECFUSDN",
"bban": "401241481CLPECFUSDNT",
"currency": "USD"
},
"debtorName": "Sebastian Moore",
"transactionAmount": {
"currency": "EUR",
"amount": "25"
},
"valueDate": "2017-10-26"
}
],
"pending": null
}
}
Unauthorized
Forbidden