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 (typically 50% of Debitura's platform revenue), payment terms (net 10 business days after you invoice), invoicing currency (GBP, EUR, or USD), and termination provisions (90 days notice, 24-month tail period for existing clients).
If you have not yet signed, contact [email protected] to finalize.
Step 2: Provide your white-label 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)
Background color (hex code for page, buttons, and headers)
Font color (hex code for all text)
Font family (e.g., Inter, Helvetica, your brand typeface)
Welcome email template (optional): After a client completes onboarding, Debitura sends a branded welcome email on your behalf. You design this email together with the Debitura partnerships team using a SendGrid template. The template can include your company name, the client’s name and email, and the onboarding date. If you do not provide a template, no welcome email is sent.
These settings are applied to the white-labeled onboarding flow your clients see when signing the Standard Debt Collection Agreement (SDCA). For more detail, see White-label 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, colors, and fonts appear correctly. Walk through the three onboarding steps (company details, users, SDCA signing).
Welcome email: After completing test onboarding, verify the welcome email arrives with your branding and messaging.
Return URL: If your developer has configured a return URL, verify that after onboarding you are redirected back to your platform.
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: 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 white-labeled client signup. See API integration overview for a business-level explanation.
Technical checklist for developers: Your developer should verify all items on the integration checklist before going live. This includes client creation handling (201 and 202 responses), all three 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]. 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 platform using a bearer token.
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 do not appear in the Reporting API until a debtor has paid and the collection partner has settled, which may take weeks after case submission.
Step 7: Set up monthly invoicing
Referral partners invoice Debitura monthly for recognized fees. Before your first invoice is due, confirm your invoicing process:
What to invoice: At the end of each month, query the Reporting API for "Recognized Uninvoiced" (Stage 2) transactions. These are fees where the collection partner has already paid Debitura, so the amount is locked.
Where to send: Email your invoice to [email protected] (copy [email protected]).
Payment terms: Net 10 business days after Debitura receives your invoice.
Currency: Invoice in the currency specified in your partnership agreement (GBP, EUR, or USD).
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 white-labeled onboarding flow, cases are submitted through your platform, and your earnings are tracked in the Reporting API. You invoice Debitura monthly for recognized fees.
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 issues, your developer can contact [email protected]. For partnership or commercial questions, contact [email protected].