Getting started

Welcome! This guide will help you quickly get up and running with the Debbie Creditor API.

​

1. Get access to the creditor portal

Your debt collection partner will invite you to the creditor portal. If you do not have access yet, please reach out to them.

​

2. Create an API key

In the creditor portal, navigate to the Developer section in the menu. From there, you can create a new API key and select the scopes it should have access to. On the same page you will find your tenantId and creditorId. You will need both when calling the API — the tenantId is part of every URL, and the creditorId identifies you as the creditor.

​

3. Understand the core concepts

Before diving into the endpoints, we recommend reading the Core Concepts section to familiarize yourself with how customers, cases and case vouchers fit together.

​

4. Build your integration

The smallest useful integration is two endpoints:

1. Create customer — create the customer with the debtor’s contact details.
2. Add case vouchers — send the unpaid invoices and fees for collection.

The platform automatically determines when to create a new case or update an existing one.

​

5. Subscribe to webhooks

You can be notified when data changes instead of polling. Add a webhook with the events you want — cases, payments and billings are available — either in the creditor portal under Developers → Webhooks, or with Create webhook. A webhook only receives events for your own creditor. Every delivery carries an X-Verification-Token header with the token issued when the webhook was created. Compare it with the stored value and reject requests that do not match. See the Webhooks reference for delivery behaviour and the payloads.

​

6. Build the rest of the flow

A full integration also attaches documentation, reports the payments the debtor makes directly to you, and posts the settlement when the money comes back. The Invoice-to-cash integration guide walks through all of it in order.