# finperks API documentation

> Guides and reference for the finperks API for viewing giftcard products, creating orders and reconciling settlements.

The complete, machine-readable OpenAPI 3.1 specification — including every endpoint, parameter, and request/response schema — is available at https://docs.finperks.com/openapi/api.yaml. Use it as the source of truth for the API reference.

## Table of Contents

- [Accessing the API](https://docs.finperks.com/accessing_the_api.md): The API is accessible via **HTTPS** and uses **JSON for requests** and **JSON for responses**.
- [API Stability](https://docs.finperks.com/api_stability.md): We will make **backwards-compatible changes** to **finperks Giftcard API** without releasing a new version.
- [Authentication](https://docs.finperks.com/authentication.md): The **finperks Giftcard API** requires **requests** to be **signed** for authentication.
- [Client Partners](https://docs.finperks.com/client_partners.md): When you are not ordering the gift cards directly for the end-user, it is necessary to provide information about the partner for whom the gift card...
- [Errors](https://docs.finperks.com/errors.md): The **finperks Giftcard API** returns different HTTP error codes in the 4xx and 5xx ranges.
- [Getting Started](https://docs.finperks.com/getting_started.md): This guide walks you through your first signed request and your first sandbox order. It should
- [Idempotency](https://docs.finperks.com/idempotency.md): Most methods on resources in the **finperks Giftcard API** can or even must be used in an
- [Introduction](https://docs.finperks.com/introduction.md): The **finperks Giftcard API** allows partners to purchase giftcards.
- [Order Lifecycle](https://docs.finperks.com/order_lifecycle.md): Every order moves through a defined set of states. Understanding the lifecycle helps you decide
- [Order Presentation](https://docs.finperks.com/order_presentation.md): Once an order has been completed, the gift card information needs to reach the end customer. The recommended way to make this information available...
- [Pagination](https://docs.finperks.com/pagination.md): List endpoints — such as `GET /products`, `GET /client_partners`, and `GET /settlements` —
- [Processing Modes](https://docs.finperks.com/processing_modes.md): When creating orders, you can choose between two processing modes: **synchronous** and **asynchronous**. The processing mode determines when you re...
- [Rate Limiting](https://docs.finperks.com/rate_limiting.md): The API is rate limited by partner entity, to ensure that no single partner can use
- [Sandbox Testing](https://docs.finperks.com/sandbox_testing.md): The sandbox environment (`https://api-sandbox.finperks.com`) lets you build and test your
- [Direct Sale to Customers](https://docs.finperks.com/use_cases/direct_sale.md): In the direct sale scenario, the partner purchases gift cards and delivers them directly to end customers. This is the most common integration patt...
- [Indirect Sale via Partners](https://docs.finperks.com/use_cases/indirect_sale.md): In the indirect sale scenario, the partner operates a platform that enables other companies to offer gift cards to their respective customers or em...
- [Physical Store (Retail)](https://docs.finperks.com/use_cases/physical_store.md): In the physical store scenario, the partner operates retail locations where gift cards are sold at the point of sale. This integration pattern uses...
- [Webhooks](https://docs.finperks.com/webhooks.md): When certain events occur, our system sends an HTTPS-request to one or more URLs specified by you up front.