Finance API overview

Merchants who take payments with Zettle have an Zettle merchant account that processes transactions for the payments. For example, card payments made with Zettle card readers.

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.

Register on the Zettle Developer Portal to create credentials for the app you are building, and learn more about different types of integrations. See Get started for more information.

Explore the sections listed in the following to get an understanding of how to work with the Finance API.

Payments are card payments, card refunds, or alternative payment methods (APMs) like PayPal QR code (QRC).

For information on how Zettle handles transactions for payments, see how payments with Zettle work.

See Finance API reference.

Note: The current version of the Finance API is V2. Version V1 is deprecated but will remain available through 2022. For information about how to migrate from V1 to V2 and changes between the versions, see Finance API migration guide.

For more information on Finance API V1, see Finance API V1.

Using the Finance API, you can fetch finance-related information as follows:

• Fetch account balance
• Fetch account transactions
• Fetch payout information
• Fetch purchase information for transactions