Goal
Complete all non-technical prerequisites so your referral partner integration can go live in production. By the end of this checklist, your partnership agreement is signed, branding is configured, your developer has what they need, and you have verified a successful launch.
Prerequisites
Your company has been accepted into the Debitura Referral Partner Program.
You have received test environment API keys from the Debitura partnerships team ([email protected]).
You have a developer (or development team) available to handle the technical integration.
Step 1: Confirm your partnership agreement is signed
Before any integration work begins, make sure your referral partnership agreement with Debitura is fully executed. The agreement covers revenue sharing terms (your referral percentage of Debitura's platform revenue), payment terms, invoicing currency and how the partnership can end.
If you have not yet signed, contact [email protected] to finalize.
Step 2: Provide your branding assets
Debitura applies your branding to the client onboarding experience. Prepare and send the following to your Debitura partnerships contact:
Company logo (URL or high-resolution file)
Primary color (hex code for the one brand color used as the accent color of the onboarding pages)
Welcome email template (optional): After a client signs the SDCA in onboarding, Debitura sends a branded welcome email to each user on the client's account, with that user's own link to set a password. You design this email together with the Debitura partnerships team using a SendGrid template. The template can include your company name and each user's name, email address and set-password link. If you do not provide a template, no welcome email is sent.
These settings are applied to the co-branded onboarding flow your clients see when signing the Standard Debt Collection Agreement (SDCA). For more detail, see Co-branded onboarding - customization and branding options.
Step 3: Walk through the test environment
Use the test environment to verify the end-to-end flow before going live. The test environment mirrors production but uses separate URLs and data.
As a business/ops team member, check these items yourself (no code required):
Onboarding flow: Open a test onboarding URL in your browser. Confirm your logo and primary color appear correctly. Walk through the onboarding steps, including company details, users and SDCA signing.
Welcome email: After completing test onboarding, verify the welcome email arrives with your branding and messaging.
Return URL: With the Full Integration, if your developer has configured a return URL, verify that after onboarding you are redirected back to your platform. With the Starter Integration, the return destination is the one configured on your partner account, not one set per request; verify that you land there after completing a step.
If anything looks wrong, coordinate with the Debitura partnerships team to adjust your branding configuration.
Step 4: Brief your developer on what to build
Your developer handles the technical integration. Provide them with:
API credentials: Test API key and Partner ID (received from Debitura).
What to integrate: Choose one of two ways. With the Starter Integration, your server sends one collection request per invoice (POST /collection-requests), your collection button opens the link Debitura returns, and your platform follows each request until it becomes a case. With the Full Integration, the integration uses three APIs: (1) Referral Partner API for creating clients and generating access tokens, (2) Customer API for submitting collection cases, and (3) the Referral Onboarding app for co-branded client signup. See API integration overview for a business-level explanation.
Technical checklist for developers: Your developer should verify all items on the go-live checklist for the way you integrate. For the Starter Integration, this includes sending collection requests, opening the returned link, handling every request status and receiving the collection request update webhook (collection_request.updated); see the go-live checklist in the Developer Docs. For the Full Integration, this includes client creation handling (201 and 202 responses), all the 409 conflict scenarios, onboarding URL redirect, bearer token generation and expiration, case creation via Customer API, attribution verification in reporting, error handling, and rate limit handling.
Developer Docs: Developers: For the full technical integration guide and API reference, see Developer Docs: Referral Partners Getting Started.
Step 5: Request production API keys
Once your developer confirms the integration works in the test environment, request production credentials from the Debitura partnerships team at [email protected]. Before production access, agree with the Debitura partnerships team which countries are opened for consumer (B2C) cases. Consumer cases are off by default and are opened country by country, only where the local collection partner approves. Arrangements already specifically agreed with Debitura keep their own scope. You will receive a production API key and Partner ID. See Request credentials, environments, and support access for the full process.
Step 6: Run a soft launch
Start with a limited rollout before enabling the integration for all your clients:
Enable the integration for a small group of clients (5 to 10).
Have at least one client complete the full onboarding flow (SDCA signing) in production.
Submit at least one test collection case through your integration.
Verify the case appears in the Debitura system and is attributed to your partner account.
Verify attribution: confirm the case is linked to your partner account. You can check this in the Referral Partner Dashboard (Cases view) or via the API. Note: earnings appear in the Reporting API only after a debtor has paid, and a fee is recognized only once the collection partner's commission on that payment is settled, which may take weeks after case submission.
Step 7: Set up monthly invoicing
Referral partners invoice Debitura monthly for fees that are ready to invoice. Before your first invoice is due, confirm your invoicing process:
What to invoice: At the end of each month, query the Reporting API (GET /reporting/transactions) for fees in the Ready to Invoice Debitura stage. A fee reaches that stage by default after Debitura has received its platform fee from the collection partner, or, if your partnership agreement includes an early-invoicing exception, as soon as the collection partner's commission is settled. The Ready to Invoice tab in the Referral Partner Dashboard shows these fees.
Where to send: Email your invoice to [email protected] (copy [email protected]).
Payment terms: As set in your partnership agreement.
Currency: Invoice in the currency specified in your partnership agreement.
For full details on revenue stages and the invoicing workflow, see Revenue sharing and financial reconciliation.
Step 8: Confirm go-live
Once your soft launch is successful, enable the integration for your full client base. Notify the Debitura partnerships team that you are live.
After launch, monitor these metrics:
Client adoption rate (how many of your clients use the collection feature)
Cases submitted per month
Revenue visible in the Reporting API
Result
Your referral partner integration is live in production. Clients can sign up through your co-branded onboarding flow, cases are submitted through your platform, and your earnings are tracked in the Reporting API. You invoice Debitura monthly for fees that are ready to invoice.
If something goes wrong
If you encounter issues during or after go-live, see the Integration troubleshooting checklist. For new partners, review the Getting started as a Referral Partner guide for foundational setup steps.
For technical, partnership, and commercial questions, contact [email protected].