Finance API - latest

The type of a merchant's Zettle account. You can use one of the following account types:
  - PRELIMINARY account where transactions are to be confirmed.
  - LIQUID account where transactions are to be paid out to the merchant.


accountTypeGroup

For more information, see the [OAuth API documentation](/docs/api/oauth/overview).

The Finance API is used to fetch finance-related information that is processed through Zettle. The information includes account balance, all the transactions processed through Zettle, and payout.


Finance API

Returns the balance in a merchant's preliminary or liquid account at a specific time.

Used to fetch account balance at a certain point in time. The time is specified in ISO 8601 date time format with timezone. 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. Make sure that you encode the characters that are not permitted in a URL. For example, "2022-03-01T12:42:10.452+02:00" must be URL encoded because "+" is not a valid query parameter character.


Returns when the operation is successful. The account balance in the currency's smallest unit.  For example, 300 with currency GBP is £3.


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.

Returns all transactions or transactions of certain types from a merchant's preliminary or liquid account during a specific period.


The start time in ISO 8601 date time format with timezone (inclusive) from when the transactions will be fetched. Make sure that you encode the characters that are not permitted in a URL. For example, "2022-03-01T12:42:10.452+02:00" must be URL encoded because "+" is not a valid query parameter character.


start

The end time in ISO 8601 date time format with timezone (exclusive) before when the transactions will be fetched. Make sure that you encode the characters that are not permitted in a URL. For example, "2022-03-01T12:42:10.452+02:00" must be URL encoded because "+" is not a valid query parameter character.


Specifies the transaction types to fetch. Multiple transaction types can be specified. Available  transaction types are:
  | Transaction type        | Description | Applicable for account type |
  |-------------------------|-------------|-----------------------------|
  | ADJUSTMENT              | A bookkeeping adjustment | LIQUID, PRELIMINARY |
  | ADVANCE                 | The cash advance given by Zettle to a merchant in the liquid account. A cash advance is a type of financing that is offered to merchants based on their sales history. The advance is paid back with monthly down payments. | LIQUID |
  | ADVANCE_DOWNPAYMENT     | A down payment on a previously paid out cash advance in the liquid account. | LIQUID |
  | ADVANCE_FEE_DOWNPAYMENT | The netting of a cash advance fee in the liquid account. | LIQUID |
  | BANK_ACCOUNT_VERIFICATION (Deprecated) | Not applicable. | Not applicable |
  | CASHBACK                | Money given to a merchant to retroactively adjust the card payment fee rate. | LIQUID |
  | FAILED_PAYOUT           | A previous payout transaction failed and was made void. The payout money is returned to the merchant's liquid account. | LIQUID |	
  | FROZEN_FUNDS            | The money that is frozen to cover a chargeback. When the issuing bank initiates a chargeback, the money will be removed from the merchant's liquid account and marked as frozen to cover the chargeback. If the chargeback is later revoked, the money will be returned to the merchant's liquid account with a new and positive transaction of the same type. It effectively makes the initial FROZEN_FUNDS transaction void. | LIQUID |
  | INVOICE_PAYMENT         | An invoice payment. If an invoice is paid through a card payment, the payment type is PAYMENT.| LIQUID, PRELIMINARY |	
  | INVOICE_PAYMENT_FEE     | An invoice payment fee. If an invoice is paid through a card payment, the payment fee type is PAYMENT_FEE. | LIQUID, PRELIMINARY |
  | PAYMENT                 | A payment where Zettle handles the funds. This includes any type of payment, such as card payments and other alternative payment methods. In the case of a refund, a transaction of the same type will occur but with the inverted amount. Contains a reference to the payment in the Purchase API. | LIQUID, PRELIMINARY |
  | PAYMENT_FEE             | The fee for a payment where Zettle handles the funds. The amount is positive in case of a refund. Contains a reference to the payment fee in the Purchase API. | LIQUID, PRELIMINARY |
  | PAYMENT_PAYOUT          | A payment payout with a negative amount is a transfer of money for a single payment from merchant's liquid account to PayPal Wallet. A payment payout with a positive amount is a transfer of money for a refund from PayPal Wallet to the merchant's liquid account.  | LIQUID |
  | PAYOUT                  | A payout can be positive or negative. If the account balance is paid out from the merchant’s liquid account to the merchant’s bank account or to PayPal Wallet for PayPal users, the payout is negative. If the merchant’s configuration has a minimum account balance, the payout is the liquid account balance minus the minimum account balance. For example, if the account balance is £147 and the minimum account balance is £47, the payout is £100. For PayPal users, if a refund happens, a payout will be made from PayPal Wallet to the liquid account. In this case, the amount is positive.  | LIQUID |

Note: Deprecated transaction types are no longer in use, but may appear in historic data.


includeTransactionType

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. The maximum limit allowed is 10000.
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.


limit

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.


offset

Returns when the operation is successful.

Returns when a required parameter is missing or in a wrong format in the request.

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.


Used to fetch payouts at a certain point in time. The time is specified in ISO 8601 date time format with timezone. 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. Make sure that you encode the characters that are not permitted in a URL. For example, "2022-03-01T12:42:10.452+02:00" must be URL encoded because "+" is not a valid query parameter character.
