Skip to main content

Introduction

Welcome to the SalesFinance API integration documentation. This guide helps you integrate the Svea SalesFinance service — commonly referred to as StorePay — into your platform, enabling a smooth financing experience for your customers.

Why use the SalesFinance API integration?​

The integration provides a straightforward way to embed the financing process directly into your existing systems. This allows you to effortlessly create and manage new financing applications and receive real-time updates as the application status changes, all without needing to use our separate web interface.

Currently only Sweden is supported in the API.

Key Definitions and Participants​

This section introduces the central participants (the key roles) and defines the core concepts and data objects you will encounter in the integration.

Participants (The Roles)​

  • Applicant

    • The individual applying for the financing. This person is central to the application process.
    • This role refers to the primary applicant. The term also encompasses the single allowed co-applicant when one is invited.

  • Merchant

    • The organization (that's you) that integrates with Svea to offer financing as a payment option. You initiate the financing application process via the API and listen to application events when they occur.

  • Store

    • Your physical or digital store where the sale takes place.
    • Referred to as Client in the integration

  • Integrator

    • The party that manages the API integration, sometimes on behalf of multiple merchants. It is conceptually the parent to a merchant. This party is the logical owner of the Client Credentials used for OAuth access.

Core Definitions (The Concepts)​

  • Application / Order

    • The central data object that represents the customer's full financing process. You create and manage this Order via the API, tracking it from its initial creation until the goods or services it finances have been delivered to the applicant (or is denied by Svea). You should listen to status changes.

  • Campaign

    • A campaign defines the specific financial terms for an application, such as financing options, interest rates, and fees. Campaigns have an upper and lower limit to the financing amounts it can support. Every application is tied to a campaign.

  • Capture

    • When the goods or services have been delivered, you are able to capture the payment.