Introduction

​

What is the paywise Partner API?

The paywise Partner API is designed for integration partners who want to incorporate paywise and its services into their systems or want to manage groups of companies.

​

Typical Use Cases:

• SaaS platforms: Provide your users with a seamless experience for managing their receivables.
• Parent companies: Manage multiple companies within a group using the Partner API.

​

What can you do with the Partner API?

The Partner API supports three main functionalities:

• Create Client Companies on paywise.
• Onboard Users as members of their respective companies.
• Perform debt collection processes for your Client Companies, including claim submissions, retrieving case status updates, and more.

​

What’s the Difference Between the Partner API and the Case Management API?

The paywise platform offers two APIs to meet different needs:

​

Partner API:

• Focused on creating and managing paywise accounts for your companies and onboarding their users.

​

Case Management API:

• Enables companies to perform the entire debt collection process via API.

​

Key Points:

• As a Partner, you can use the Case Management API on behalf of your client companies to manage their debt collection processes.
• To do so, include a custom header (X-User-Id) with each request to the Case Management API, alongside your Partner Token in the Authorization header.

For more details, explore:

• API-Only Onboarding
• Web Flow Onboarding

​

Before You Start

Before starting your technical integration with the Partner API, we’d love to hear from you! Send us an email at [email protected], and we’ll discuss your use case and recommend the best approach.

​

Next Steps:

​

Release Notes

Stay up to date with the latest features and improvements by regularly checking our release notes.

​

January 2025

​

January 20

• Add field default_claim_type to company entity
• Add field iban to company entity

​

October 2024

​

October 21 - Initial Release

• 🎉 Initial release of the Partner API!