Fetch account transactions
Use the Finance API to fetch transactions or transactions of certain types from a merchant's liquid account during a specific period.
- Make sure that authorisation is set up with the following OAuth scope using OAuth API:
READ:FINANCE
When fetching transactions from a merchant's Zettle account during a specific period, set pagination to avoid a big dataset in a response. The transactions should be fetched from the merchant's liquid account.
- Send a request where you set
limit
as the number of transactions to fetch andoffset
as0
.GET /v2/accounts/{accountTypeGroup}/transactions?start={start_time}&end={end_time}&limit={limit_value}&offset={offset_value}
Example: The following example fetches the latest three transactions from the merchant's liquid account from 1 January, 2020 to 5 July, 2020.RequestGET /v2/accounts/liquid/transactions?start=2020-01-01T00:00:00-00:00&end=2020-07-06T00:00:00-00:00&limit=3&offset=0
Response - Send another request where you keep
limit
the same as in step 1 and incrementoffset
with the value oflimit
.GET /v2/accounts/{accountTypeGroup}/transactions?start={start_time}&end={end_time}&limit={limit_value}&offset={offset_value}
Example: The following example fetches the next three transactions from the merchant's liquid account from 1 January, 2020 to 5 July, 2020.RequestGET /v2/accounts/liquid/transactions?start=2020-01-01T00:00:00-00:00&end=2020-07-06T00:00:00-00:00&limit=3&offset=3
Response - Repeat step 2 until the response is empty or it contains fewer transactions than the
limit
.Example: The following example shows that last two transactions are fetched from the merchant's liquid account from 1 January, 2020 to 5 July, 2020.RequestGET /v2/accounts/liquid/transactions?start=2020-01-01T00:00:00-00:00&end=2020-07-06T00:00:00-00:00&limit=3&offset=30
Response
You can fetch transactions of certain types from a merchant's Zettle account during a specific period. For example, you can fetch all payments. The transactions should be fetched from the merchant's liquid account.
Send a request where you specify transaction types as you need. See supported transaction types in Finance API reference V2.
GET /v2/accounts/liquid/transactions?start={start_date}&end={end_date}&includeTransactionType={includeTransactionType}
Example: The following example fetches all payments and associated payment fees from the merchant's liquid account. The transactions are fetched from 1 January, 2020 to 31 December, 2020.
Request
GET /v2/accounts/liquid/transactions?start=2020-01-01T00:00:00-00:00&end=2021-01-01T00:00:00-00:00&includeTransactionType=PAYMENT&includeTransactionType=PAYMENT_FEE
Response
Example: The following example fetches all the transactions that are are included in the payout from the merchant's liquid account. The transactions are fetched from 6 September, 2020 to 10 September, 2020.
Request
GET /v2/accounts/liquid/transactions?start=2020-09-06T00:00:00-00:00&end=2020-09-11T00:00:00-00:00&includeTransactionType=PAYOUT
Response