{ "opencollection": "1.0.0", "info": { "name": "Finance accounts API", "version": "2.0" }, "items": [ { "info": { "name": "accounts", "type": "folder" }, "items": [ { "info": { "name": "Get account balance", "type": "http" }, "http": { "method": "GET", "url": "https://finance.izettle.com/v2/accounts/:accountTypeGroup/balance", "params": [ { "name": "accountTypeGroup", "value": "", "type": "path", "description": "The type of a merchant's Zettle account. You can use one of the following account types:\n - PRELIMINARY account where transactions are to be confirmed.\n - LIQUID account where transactions are to be paid out to the merchant.\n" }, { "name": "at", "value": "", "type": "query", "description": "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.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://oauth.zettle.com/authorize", "accessTokenUrl": "https://oauth.zettle.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the balance in a merchant's preliminary or liquid account at a specific time." }, { "info": { "name": "Get account transactions", "type": "http" }, "http": { "method": "GET", "url": "https://finance.izettle.com/v2/accounts/:accountTypeGroup/transactions", "params": [ { "name": "accountTypeGroup", "value": "", "type": "path", "description": "The type of a merchant's Zettle account. You can use one of the following account types:\n - PRELIMINARY account where transactions are to be confirmed.\n - LIQUID account where transactions are to be paid out to the merchant.\n" }, { "name": "start", "value": "", "type": "query", "description": "The start time in UTC (inclusive) from when the transactions will be fetched.\n" }, { "name": "end", "value": "", "type": "query", "description": "The end time in UTC (exclusive) before when the transactions will be fetched.\n" }, { "name": "includeTransactionType", "value": "", "type": "query", "description": "Specifies the transaction types to fetch. Multiple transaction types can be specified. Available transaction types are:\n | Transaction type | Description | Applicable for account type |\n |-------------------------|-------------|-----------------------------|\n | ADJUSTMENT | A bookkeeping adjustment | LIQUID, PRELIMINARY |\n | ADVANCE | The cash advance given by Zettle to a merchant in the liquid account. | LIQUID |\n | ADVANCE_DOWNPAYMENT | A down payment on a previously paid out cash advance in the liquid account. | LIQUID |\n | ADVANCE_FEE_DOWNPAYMENT | The netting of a cash advance fee in the liquid account. | LIQUID |\n | CASHBACK | Money given to a merchant to retroactively adjust the card payment fee rate. | LIQUID |\n | FAILED_PAYOUT | A previous payout transaction failed and was made void. | LIQUID |\n | FROZEN_FUNDS | The money that is frozen to cover a chargeback. | LIQUID |\n | INVOICE_PAYMENT | An invoice payment. | LIQUID, PRELIMINARY |\n | INVOICE_PAYMENT_FEE | An invoice payment fee. | LIQUID, PRELIMINARY |\n | PAYMENT | A payment where Zettle handles the funds. | LIQUID, PRELIMINARY |\n | PAYMENT_FEE | The fee for a payment where Zettle handles the funds. | LIQUID, PRELIMINARY |\n | PAYMENT_PAYOUT | A payment payout transfer. | LIQUID |\n | PAYOUT | A payout to the merchant's bank account or PayPal Wallet. | LIQUID |\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of transactions to return in a response.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The number of transactions to skip before beginning to return in a response.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://oauth.zettle.com/authorize", "accessTokenUrl": "https://oauth.zettle.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all transactions or transactions of certain types from a merchant's preliminary or liquid account during a specific period.\n" } ] } ], "bundled": true }