ZettleOauth
For more information, see the OAuth API documentation.
Security Scheme Type | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: https://oauth.zettle.com/authorize Token URL: https://oauth.zettle.com/token Scopes:
|
accounts
Returns the balance in a merchant's preliminary or liquid account at a specific time.
Request
READ:FINANCE
QUERY PARAMETERS
at | string<YYYY-MM-DDThh:mm:ss>Default: NOW() Used to fetch account balance at a certain point in time. The time is specified in UTC. If this parameter is used, any transaction after that point will be ignored. If not, the balance of all transactions at the current point in time is returned. |
Responses
Returns when a required parameter is missing or in a wrong format in the request
Returns when one of the following occurs:
- The authentication information is missing in the request.
- The authentication token has expired.
- The authentication token is invalid.
Returns when the scope being used in the request is incorrect.
1curl --request GET \2--url 'https://finance.izettle.com/v2/accounts/{accountTypeGroup}/balance?at=2022-03-01T12:42:10' \3--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
1const request = require('request');23const options = {4method: 'GET',5url: 'https://finance.izettle.com/v2/accounts/{accountTypeGroup}/balance',6qs: {at: '2022-03-01T12:42:10'},7headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}8};910request(options, function (error, response, body) {11if (error) throw new Error(error);1213console.log(body);14});
1HttpResponse<String> response = Unirest.get("https://finance.izettle.com/v2/accounts/{accountTypeGroup}/balance?at=2022-03-01T12:42:10")2.header("Authorization", "Bearer REPLACE_BEARER_TOKEN")3.asString();
1import http.client23conn = http.client.HTTPSConnection("finance.izettle.com")45headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }67conn.request("GET", "/v2/accounts/{accountTypeGroup}/balance?at=2022-03-01T12:42:10", headers=headers)89res = conn.getresponse()10data = res.read()1112print(data.decode("utf-8"))
1package main23import (4"fmt"5"net/http"6"io/ioutil"7)89func main() {1011url := "https://finance.izettle.com/v2/accounts/{accountTypeGroup}/balance?at=2022-03-01T12:42:10"1213req, _ := http.NewRequest("GET", url, nil)1415req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")1617res, _ := http.DefaultClient.Do(req)1819defer res.Body.Close()20body, _ := ioutil.ReadAll(res.Body)2122fmt.Println(res)23fmt.Println(string(body))2425}
1{2"totalBalance": 300,3"currencyId": "GBP"4}
Returns all transactions or transactions of certain types from a merchant's preliminary or liquid account during a specific period.
Request
READ:FINANCE
QUERY PARAMETERS
startrequired | string<YYYY-MM-DDThh:mm:ss> The start time in UTC (inclusive) from when the transactions will be fetched. | ||||||||||||||||||||||||||||||||||||||||||
endrequired | string<YYYY-MM-DDThh:mm:ss> The end time in UTC (exclusive) before when the transactions will be fetched. | ||||||||||||||||||||||||||||||||||||||||||
includeTransactionType | array Specifies the transaction types to fetch. Multiple transaction types can be specified. Available transaction types are:
| ||||||||||||||||||||||||||||||||||||||||||
limit | integerDefault: 10000 The maximum number of transactions to return in a response. You must specify limit with any integer greater than 0. To avoid a big dataset in a response, use limit and offset together to set response pagination. For example, to return only three transactions at a time from a collection of transactions for a specific period, set limit as 3 and offset as 0 in the first request. Then set limit as 3 and increment offset with 3 in the second request and repeat the request until all transactions are fetched. | ||||||||||||||||||||||||||||||||||||||||||
offset | integer0 The number of transactions to skip before beginning to return in a response. You must specify offset with any integer greater than or equal to 0. Use limit and offset together to set pagination on the response to avoid returning a big dataset. |
Responses
Returns when a required parameter is missing or in a wrong format in the request.
Returns when one of the following occurs:
- The authentication information is missing in the request.
- The authentication token has expired.
- The authentication token is invalid.
Returns when the scope being used in the request is incorrect.
1curl --request GET \2--url 'https://finance.izettle.com/v2/accounts/{accountTypeGroup}/transactions?start=2022-03-01T12:42:10&end=2022-03-01T12:42:10&includeTransactionType=SOME_ARRAY_VALUE&limit=1000&offset=3' \3--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
1const request = require('request');23const options = {4method: 'GET',5url: 'https://finance.izettle.com/v2/accounts/{accountTypeGroup}/transactions',6qs: {7start: '2022-03-01T12:42:10',8end: '2022-03-01T12:42:10',9includeTransactionType: 'SOME_ARRAY_VALUE',10limit: '1000',11offset: '3'12},13headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}14};1516request(options, function (error, response, body) {17if (error) throw new Error(error);1819console.log(body);20});
1HttpResponse<String> response = Unirest.get("https://finance.izettle.com/v2/accounts/{accountTypeGroup}/transactions?start=2022-03-01T12:42:10&end=2022-03-01T12:42:10&includeTransactionType=SOME_ARRAY_VALUE&limit=1000&offset=3")2.header("Authorization", "Bearer REPLACE_BEARER_TOKEN")3.asString();
1import http.client23conn = http.client.HTTPSConnection("finance.izettle.com")45headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }67conn.request("GET", "/v2/accounts/{accountTypeGroup}/transactions?start=2022-03-01T12:42:10&end=2022-03-01T12:42:10&includeTransactionType=SOME_ARRAY_VALUE&limit=1000&offset=3", headers=headers)89res = conn.getresponse()10data = res.read()1112print(data.decode("utf-8"))
1package main23import (4"fmt"5"net/http"6"io/ioutil"7)89func main() {1011url := "https://finance.izettle.com/v2/accounts/{accountTypeGroup}/transactions?start=2022-03-01T12:42:10&end=2022-03-01T12:42:10&includeTransactionType=SOME_ARRAY_VALUE&limit=1000&offset=3"1213req, _ := http.NewRequest("GET", url, nil)1415req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")1617res, _ := http.DefaultClient.Do(req)1819defer res.Body.Close()20body, _ := ioutil.ReadAll(res.Body)2122fmt.Println(res)23fmt.Println(string(body))2425}
1[2{3"timestamp": "2022-03-01T12:42:10",4"amount": 300,5"originatorTransactionType": "PAYOUT",6"originatorTransactionUuid": "5e8673e4-a52f-11ec-b909-0242ac120002"7}8]
payout
Returns payout related information from a merchant's liquid account. A payout is a deposit made to a merchant's bank account or a PayPal Wallet for PayPal users. If the merchant's configuration has a minimum account balance, then the payout will deposit the account balance minus the minimum account balance.
Request
READ:FINANCE
QUERY PARAMETERS
at | string<YYYY-MM-DDThh:mm:ss>Default: NOW() Used to fetch payouts at a certain point in time. The time is specified in UTC. If this parameter is used, any transaction after that time will be ignored. If not, the account balance at the current point in time is returned. |
Responses
Returns when a required parameter is missing or in a wrong format in the request.
Returns when one of the following occurs:
- The authentication information is missing in the request.
- The authentication token has expired.
- The authentication token is invalid.
Returns when the scope being used in the request is incorrect.
1curl --request GET \2--url 'https://finance.izettle.com/v2/payout-info?at=2022-03-01T12:42:10' \3--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
1const request = require('request');23const options = {4method: 'GET',5url: 'https://finance.izettle.com/v2/payout-info',6qs: {at: '2022-03-01T12:42:10'},7headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}8};910request(options, function (error, response, body) {11if (error) throw new Error(error);1213console.log(body);14});
1HttpResponse<String> response = Unirest.get("https://finance.izettle.com/v2/payout-info?at=2022-03-01T12:42:10")2.header("Authorization", "Bearer REPLACE_BEARER_TOKEN")3.asString();
1import http.client23conn = http.client.HTTPSConnection("finance.izettle.com")45headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }67conn.request("GET", "/v2/payout-info?at=2022-03-01T12:42:10", headers=headers)89res = conn.getresponse()10data = res.read()1112print(data.decode("utf-8"))
1package main23import (4"fmt"5"net/http"6"io/ioutil"7)89func main() {1011url := "https://finance.izettle.com/v2/payout-info?at=2022-03-01T12:42:10"1213req, _ := http.NewRequest("GET", url, nil)1415req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")1617res, _ := http.DefaultClient.Do(req)1819defer res.Body.Close()20body, _ := ioutil.ReadAll(res.Body)2122fmt.Println(res)23fmt.Println(string(body))2425}
1{2"totalBalance": 300,3"currencyId": "GBP",4"nextPayoutAmount": 2000,5"discountRemaining": 9800,6"periodicity": "DAILY"7}