v1
latestOpenAPI 3.0.12026-08-0674476716.0 KBGet account transactions
The GET /accounts/{accountId}/transactions endpoint retrieves information for all transactions in a given account.
Path parameters
The system-generated unique bank account id, which specifies the account for which the information is requested.
Query parameters
The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (<i>i.e.</i> this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data. <br/>The offset is not visible to a user and should not be parsed and/or understood in any way.
The maximum number of records to return. This must be less than 200.
The earliest transaction date requested, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format.
The latest transaction date requested, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format.
Headers
The tokenId represents the consent granted by the user (PSU).
The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is inferred that the user is present during the session (<i>i.e.</i>, the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.
Response
Successful response
Example response
{
"offset": "LerV6Jmex",
"status": "SUCCESSFUL_REQUEST",
"transactions": [
{
"amount": {
"currency": "EUR",
"value": "10.23"
},
"bankTransactionCode": {
"domain": {
"code": "PMNT",
"familyCode": "RCDT",
"subFamilyCode": "ESCT"
},
"proprietary": {
"code": "XXXX",
"issuer": "XXXX"
}
},
"bankTransactionId": "83KiRJuXmEDV5m2b8ZvLGE91ELf7PPw5BaDab98kMguu:3VMczyq7r7b6HwC",
"creditorEndpoint": {
"accountIdentifier": {
"bankgiro": {
"bankgiroNumber": "56781234"
}
},
"bankId": "ob-modelo",
"bic": "BOFIIE2D",
"customerData": {
"address": {
"city": "Berlin",
"conscriptionNumber": "2831",
"country": "DE",
"district": "Friedrichshain",
"flats": "21A - 21C",
"full": "Fifth house on the left after the village oak, Smalltown, Smallcountry",
"hamlet": "Botzowviertel",
"houseName": "Grossen Blauen Haus",
"houseNumber": "123",
"place": "Arnswalder Platz",
"postCode": "10243",
"province": "BC",
"state": "CA",
"street": "Hans-Otto-Strasse",
"subdistrict": "Friedrichshain Nord",
"suburb": "Altona Meadows Suburb"
}
}
},
"description": "Payment",
"id": "tt:83KiRJuXmEDV5m2b8ZvLGE91ELf7PPw5BaDab98kMguu:3VMczyq7r7b6HwC",
"providerTransactionDetails": {
"budapestApiTransactionDetails": {
"creditorAccount": {
"iban": "GB29NWBK60161331926819"
},
"creditorName": "ACME Company",
"debtorAccount": {
"iban": "GB29NWBK60161331926819"
},
"debtorName": "John Smith",
"transactionCategory": "Credit"
},
"cma9ApiTransactionDetails": {
"creditorAccount": {
"schemeName": "Purchase instalment plan"
},
"creditorAgent": {
"creditorAgentAddress": {
"addressLine": [
"Flat 2, The Red Lodge, 1 High Street"
],
"addressType": "BUSINESS",
"buildingNumber": "1",
"country": "GB",
"countrySubDivision": [
"North Yorkshire"
],
"department": "1",
"postCode": "YO62 5JB",
"streetName": "High Street",
"subDepartment": "Flat 2",
"townName": "York"
},
"creditorAgentName": "Creditor bank",
"identification": "98765432",
"schemeName": "Purchase instalment plan"
},
"debtorAccount": {
"cardInstrument": {
"accountIdentification": "a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC"
},
"schemeName": "Purchase instalment plan"
},
"debtorAgent": {
"debtorAgentAddress": {
"addressLine": [
"Flat 2, The Red Lodge, 1 High Street"
],
"addressType": "BUSINESS",
"buildingNumber": "1",
"country": "GB",
"countrySubDivision": [
"North Yorkshire"
],
"department": "1",
"postCode": "YO62 5JB",
"streetName": "High Street",
"subDepartment": "Flat 2",
"townName": "York"
},
"debtorAgentName": "Debtor bank.",
"schemeName": "Purchase instalment plan"
},
"merchantDetails": {
"merchantCategoryCode": "5699-V",
"merchantName": "Merchants R US"
}
},
"czechApiTransactionDetails": {
"creditorAccount": {
"iban": "GB29NWBK60161331926819",
"bban": "NWBK60161331926819"
},
"debtorAccount": {
"iban": "GB29NWBK60161331926819",
"bban": "NWBK60161331926819"
}
},
"nextGenPsd2TransactionDetails": {
"additionalInformation": "Additional bank information",
"domain": {
"code": "PMNT",
"familyCode": "RCDT",
"subFamilyCode": "ESCT"
},
"checkId": "4vn6aDyMiwBYbP",
"creditorAccount": {
"bban": "NWBK60161331926819",
"currency": "EUR",
"iban": "GB29NWBK60161331926819",
"msisdn": "447949123456",
"pan": "4658552288550023"
},
"creditorId": "4vn6aDyMiwBYbP",
"creditorName": "ACME Company",
"currencyExchange": [
{
"quotationDate": "2022-04-05T17:00:00.000Z",
"sourceCurrency": "EUR",
"targetCurrency": "EUR",
"unitCurrency": "1.4 to 1."
}
],
"debtorAccount": {
"bban": "NWBK60161331926819",
"currency": "EUR",
"iban": "GB29NWBK60161331926819",
"msisdn": "447949123456",
"pan": "4658552288550023"
},
"debtorName": "John Smith",
"endToEndId": "6aDyMiwB",
"entryReference": "72REftaRoiaDYRDU",
"mandateId": "DE452399865089",
"purposeCode": "DVPM",
"remittanceInformationStructured": "REf:taRoiaDY34DU",
"ultimateCreditor": "ACME GmbH",
"ultimateDebtor": "John Smith",
"valueDate": "2022-03-27T17:00:00.000Z"
},
"polishApiTransactionDetails": {
"accountBaseCurrency": "EUR",
"baseCurrency": "EUR",
"cardInfo": {
"cardHolder": "Piotr Brama",
"cardNumber": "5687243201834817"
},
"holdExpirationDate": "2022-11-12T17:00:00.000Z",
"initiator": {
"value": [
"ACME Business Ltd, 299 Zywiecka, Gdansk"
]
},
"mcc": "5699-V",
"recipient": {
"bank": {
"bicOrSwift": "HBUKGB7F261",
"code": "BKAFEWFK564",
"countryCode": "PL",
"name": "Polska Bank"
},
"nameAddress": {
"value": [
"ACME Business Ltd, 299 Zywiecka, Gdansk"
]
}
},
"rejectionDate": "2022-10-23T17:00:00.000Z",
"sender": {
"bank": {
"bicOrSwift": "HBUKGB7F261",
"code": "BKAFEWFK564",
"countryCode": "PL",
"name": "Polska Bank"
},
"nameAddress": {
"value": [
"ACME Business Ltd, 299 Zywiecka, Gdansk"
]
}
},
"taxInfo": {
"formCode": "49DtA9CoF9qYzh77FA9nVrCn2jia:5zKtXEAq",
"obligationId": "DECISION",
"payerInfo": {
"payerId": "444433332211",
"payerIdType": "R"
},
"periodId": "11",
"periodType": "Month",
"year": 2022
},
"tppName": "Mario's Pizzas",
"tppTransactionId": "esaWvvr4l32iaDRqvrekkfwe212vsfvkcddEaVFaVR:4DVLaMVWER4VC6b",
"tradeDate": "2022-11-30T17:00:00.000Z",
"transactionRate": [
{
"fromCurrency": "EUR",
"toCurrency": "EUR"
}
],
"transactionType": "CREDIT",
"zusInfo": {
"payerInfo": {
"nip": "444433332211"
}
}
},
"slovakApiTransactionDetails": {
"creditorAccount": {
"iban": "GB29NWBK60161331926819",
"bban": "NWBK60161331926819"
},
"debtorAccount": {
"iban": "GB29NWBK60161331926819",
"bban": "NWBK60161331926819"
}
},
"stetTransactionDetails": {
"creditorAccount": {
"iban": "GB29NWBK60161331926819"
},
"debtorAccount": {
"iban": "GB29NWBK60161331926819"
},
"valueDate": "2023-08-11"
}
},
"status": "PROCESSING",
"tokenId": "tt:8zK1dic95omjWb72gvc3z3ELKbTNfnGd89MbDnM73er4:ZhBVAJSH8DeU1",
"tokenTransferId": "t:2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV"
}
]
}