overview.md

Finance API overview

Merchants who take payments with Zettle have an Zettle 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.

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.

Understand how payments work at Zettle

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 work at Zettle.

Understand the Finance API

The API reference is a YAML file. You can render it with one of the following:

• Import it in a Postman collection.
• Upload it to ReDoc.

See Finance API V2 reference.

Fetch transactions

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