Paginate Transactions
The pagination endpoint can be used to acquire the next page of transactions of a specific account of the consumer.
Request
POST xs2a/v1/sessions/{session_id}/flows/{flow_id}/list HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: Token <Token>
Host: <Host>
{
"offset": String
}
offset String, required
The offset is the offset from the pagination object and it specifies the next page of transactions.
Response
{
"data": {
"result": ?{
"transactions": Array<Transaction>,
"account": Account,
"from_date": String,
"to_date": String,
"incomplete": Boolean,
"type": String,
"pagination": ?Pagination
},
"state": Enum<'PROCESSING', 'CONSUMER_INPUT_NEEDED', 'ABORTED', 'EXCEPTION', 'FINISHED'>
}
}
data.result.type String, always present
For successful flows the type property always holds the value transactions.
data.result.transactions Transaction[], always present
An array that contains the extracted transactions.
data.result.from_date Date (String: "YYYY-MM-DD"), always present
The start date of the timeframe for which the transactions were extracted (inclusive).
data.result.to_date Date (String: "YYYY-MM-DD"), always present
The end date of the timeframe for which the transactions were extracted (inclusive).
data.result.incomplete Boolean, always present
The incomplete boolean indicates whether or not all of the available transactions for the given timeframe could be retrieved.
Please see the section "Transactions Flows flagged as incomplete" below for further information on how to handle incomplete transaction results.
data.result.pagination Pagination, optional
The pagination object indicates whether or not a pagination is available. This object will not be present if there are no available pages. See Transactions Next for more information on this use case.
Example Response for a successful pagination call
{
"data": {
"result": {
"transactions": [
{
"reference": "Flight 123",
"amount": {
"amount": 1200,
"currency": "EUR"
},
"original_amount": {
"amount": 12345,
"currency": "SEK"
},
"counter_party": {
"id": "123e4567-e89b-12d3-a456-426655440000",
"alias": "Girokonto",
"account_number": "123456789",
"iban": "DE44500105175407324931",
"holder_name": "Max Mustermann",
"holder_address": {
"street_address": "Konrad-Adenauer-Straße 21",
"street_address2": "Backside of the House, Floor 2",
"postalcode": "35440",
"city": "Linden",
"region": "Hesse",
"country": "DE"
},
"bank_code": "51091700",
"bic": "VRBUDE51XXX",
"bank_name": "VR Bank Untertaunus eG",
"bank_address": {
"street_address": "Konrad-Adenauer-Straße 21",
"street_address2": "Backside of the House, Floor 2",
"postalcode": "35440",
"city": "Linden",
"region": "Hesse",
"country": "DE"
},
"transfer_type": "NONE",
"account_type": "DEFAULT"
},
"date": "2018-10-23",
"state": "PROCESSED",
"type": "DEBIT",
"method": "TRANSFER"
}
],
"account": {
"id": "123e4567-e89b-12d3-a456-426655440000",
"alias": "Girokonto",
"account_number": "123456789",
"iban": "DE44500105175407324931",
"holder_name": "Max Mustermann",
"bank_code": "51091700",
"bic": "VRBUDE51XXX",
"bank_name": "VR Bank Untertaunus eG",
"transfer_type": "FULL",
"account_type": "DEFAULT",
"balance": {
"amount": 12345,
"currency": "EUR"
}
},
"from_date": "2018-10-05",
"to_date": "2018-10-25",
"incomplete": false,
"pagination": {
"count": 4000,
"url": "https://api.openbanking.playground.klarna.com/xs2a/v1/sessions/t2nt3piqith2hretkh6hhcuchuir510b/flows/5p80e29nr1gbe75rglt8ifl61lq9cuu0/list",
"next": {
"offset": "EYNYcTCDOqx4+8RhyMHjPKnW87ifsANLiUANDD4zDt5oO3I3y4y5Rpt0J7Cxn2RpcljIjVKm7jrGUSIVJZpkhvD7boUxUww0CTeryoLYp5fGJBWM4M+/kION/bVOCRtOSc2qT6rKcj4I5n4I2H7z+9qCWoJ5lxnRebmTxXu7y2f2+/QjrJd2K8TZak+c11rScvdMkU0ak1Fp3dxUdbRqPfO5BvBPv1rpk3a9Sb4DRlyF7Laq1WVzmK/DG0vE1zvAYk2MO5z3b0vFxnn+8LoAWD4ePDWdXtd0pFk+J7BigFv8VDC5K+8uTyG4IU8LO/0Wn2nM7j1ch1l4dsQeqze0tkEIo/PhwOrMqMlEpSQeFycLcWjzmy/ZWFIjOj8orLXJxn3/u8hD2uGD/ZkVHXOALPSOKfo20WvQMRW+pW1cZiJVDNHloGeVXa1lt4BzZH0ws2vqwEokp+xb+wejDJGWzM8sL+5ECrtavK4P1EpUQybZoauJXRbrUfMo8VxejyF1q+ugch38LQWL0zfalQegWd76nAyZ1dp2lXSqIbayUW+KBlBFCK+2DQvWB8cJgrXo+qnJKYaSdLhpCGprrjusfIaGnBul1HSWcMqRo6HSuM0KR7pic5TpukoJl4gF9BBs2QmW1p93CVWOyD45em0QtRa7W+d7Rl5ThP3xto7fw+mkgCjp69R1eOh4YBLBpBH4TIeybv2pKcKKPBMi7tPbjvZsB6VWkYG9AEqEeNtJ4KGmC7yO2ITnSjBP5JOKxMgTlA44GZwFuaZ5wo15Y6DeyL6Huik3o21x+TtfSzjl/WqIUc5aDMLphavo8ccTcQa8eOjEpM+gy5uJTB3tiC/zWV8Dyg4IIB2tsNgq3xIL2nNufaYlGKXl/tr0VDiWOLA8x5V2QroLXWBDUpSm4+gsuhLB+yNgG/V88T8A9YY=.DPEvt4m0TPRiaOuA"
}
},
"type": "transactions"
},
"state": "FINISHED"
}
}
Pagination where no next page is available
{
"data": {
"result": {
"transactions": [
{
"reference": "Flight 123",
"amount": {
"amount": 1200,
"currency": "EUR"
},
"original_amount": {
"amount": 12345,
"currency": "SEK"
},
"counter_party": {
"id": "123e4567-e89b-12d3-a456-426655440000",
"alias": "Girokonto",
"account_number": "123456789",
"iban": "DE44500105175407324931",
"holder_name": "Max Mustermann",
"holder_address": {
"street_address": "Konrad-Adenauer-Straße 21",
"street_address2": "Backside of the House, Floor 2",
"postalcode": "35440",
"city": "Linden",
"region": "Hesse",
"country": "DE"
},
"bank_code": "51091700",
"bic": "VRBUDE51XXX",
"bank_name": "VR Bank Untertaunus eG",
"bank_address": {
"street_address": "Konrad-Adenauer-Straße 21",
"street_address2": "Backside of the House, Floor 2",
"postalcode": "35440",
"city": "Linden",
"region": "Hesse",
"country": "DE"
},
"transfer_type": "NONE",
"account_type": "DEFAULT"
},
"date": "2018-10-23",
"state": "PROCESSED",
"type": "DEBIT",
"method": "TRANSFER"
}
],
"account": {
"id": "123e4567-e89b-12d3-a456-426655440000",
"alias": "Girokonto",
"account_number": "123456789",
"iban": "DE44500105175407324931",
"holder_name": "Max Mustermann",
"bank_code": "51091700",
"bic": "VRBUDE51XXX",
"bank_name": "VR Bank Untertaunus eG",
"transfer_type": "FULL",
"account_type": "DEFAULT",
"balance": {
"amount": 12345,
"currency": "EUR"
}
},
"from_date": "2018-10-05",
"to_date": "2018-10-25",
"incomplete": false,
"pagination": {
"count": 4000,
"url": "https://api.openbanking.playground.klarna.com/xs2a/v1/sessions/t2nt3piqith2hretkh6hhcuchuir510b/flows/5p80e29nr1gbe75rglt8ifl61lq9cuu0/list"
},
"type": "transactions"
},
"state": "FINISHED"
}
}