Skip to main content

API Overview

The Collection Partner API will enable programmatic access to case management, status updates, and payment recording for partners who need automation and integration capabilities.

Coming Soon

The Collection Partner API is currently under development. This documentation outlines planned functionality. Subscribe to updates to be notified when the API launches.

What you'll be able to do​

Once available, the API will enable you to:

Case management​

  • Retrieve assigned cases and details
  • Filter and search cases
  • Access case history and timeline
  • Download case documents
  • Monitor SLA deadlines

Status updates​

  • Submit case status updates programmatically
  • Bulk update multiple cases
  • Attach notes and evidence
  • Track update history
  • Automate SLA compliance

Payment recording​

  • Record payments via API
  • Upload payment proof
  • Query payment status
  • Retrieve ledger transactions
  • Automate reconciliation
  • Browse available leads
  • Submit quotes programmatically
  • Monitor quote status
  • Auto-bidding capabilities
  • Win rate analytics

Partner case submission​

  • Submit shadow client cases
  • Upload documentation
  • Track submission status
  • Manage partner case portfolio

Reporting and analytics​

  • Export case data
  • Performance metrics
  • Financial reports
  • Custom analytics
  • Data warehouse integration

API characteristics​

RESTful design​

  • Standard HTTP methods (GET, POST, PUT, DELETE)
  • JSON request and response format
  • Intuitive resource-based URLs
  • Standard HTTP status codes

Authentication​

  • API key-based authentication
  • Secure credential management
  • Role-based access control
  • Multiple keys for different environments

Rate limiting​

  • Generous rate limits for normal usage
  • Tiered limits based on partner volume
  • Clear rate limit headers
  • Automatic retry guidance

Webhooks​

  • Real-time event notifications
  • Case status changes
  • Payment confirmations
  • New case assignments
  • SLA deadline alerts

Documentation​

  • Interactive API documentation
  • Code examples in multiple languages
  • Sandbox environment for testing
  • Comprehensive guides and tutorials

Use cases​

Integration with your case management system​

Sync cases between Debitura and your internal system:

  • Automatic case import on assignment
  • Bi-directional status synchronization
  • Unified payment tracking
  • Consolidated reporting

Automated workflows​

Build automated collection processes:

  • Scheduled status updates
  • Rule-based case routing
  • Automatic payment recording
  • Template-based communication

Business intelligence​

Integrate with analytics platforms:

  • Real-time dashboards
  • Custom reporting
  • Performance tracking
  • Financial forecasting

Client portals​

Build custom interfaces for your clients:

  • White-labeled case tracking
  • Client-specific reporting
  • Branded communication
  • Custom workflows

Technical requirements​

API access prerequisites​

  • Active collection partner agreement
  • API access enabled on your account
  • Technical contact designated
  • API terms accepted

Development environment​

Recommended setup:

  • REST client for testing
  • Secure credential storage
  • Error logging and monitoring
  • Staging environment for integration testing

Security requirements​

  • HTTPS for all API calls
  • API key rotation policy
  • IP whitelisting (optional)
  • Audit logging
  • GDPR compliance for data handling

API documentation structure​

When available, the API docs will include:

Getting started​

  • Authentication guide
  • Quick start tutorial
  • Environment setup
  • First API call walkthrough

Endpoints reference​

  • Complete endpoint listing
  • Request/response schemas
  • Query parameters
  • Error codes
  • Examples for each endpoint

Integration guides​

  • Common integration patterns
  • Best practices
  • Code samples
  • SDKs and libraries

Webhooks​

  • Event types and payloads
  • Webhook configuration
  • Security verification
  • Retry logic

Testing and debugging​

  • Sandbox environment access
  • Test data sets
  • Debugging tools
  • Common issues and solutions

Planned endpoint categories​

Cases​

GET    /api/v1/cases              # List assigned cases
GET    /api/v1/cases/{id}         # Get case details
PUT    /api/v1/cases/{id}/status  # Update case status
GET    /api/v1/cases/{id}/history # Get case timeline

Payments​

POST   /api/v1/payments           # Record a payment
GET    /api/v1/payments/{id}      # Get payment details
GET    /api/v1/ledger             # Get partner ledger
GET    /api/v1/leads              # Browse available leads
POST   /api/v1/quotes             # Submit a quote
GET    /api/v1/quotes/{id}        # Get quote status

Partner cases​

POST   /api/v1/partner-cases      # Submit partner case
GET    /api/v1/partner-cases      # List partner cases
GET    /api/v1/partner-cases/{id} # Get partner case details

Analytics​

GET    /api/v1/analytics/performance  # Get performance metrics
GET    /api/v1/analytics/financial    # Get financial summary
note

Exact endpoints and schemas are subject to change during development.

Pricing and access​

API access will be included in partner agreements based on:

  • Partner tier and volume
  • Use case and integration needs
  • Support level required
  • Rate limit requirements

Contact your account manager to discuss API access.

Development roadmap​

Phase 1: Core functionality (Q2 2026)​

  • Case retrieval and status updates
  • Payment recording
  • Basic authentication

Phase 2: Advanced features (Q3 2026)​

  • Webhooks
  • Bulk operations
  • Partner case submission
  • Enhanced filtering and search

Phase 3: Analytics and automation (Q4 2026)​

  • Advanced reporting
  • Lead bidding API
  • Auto-bidding capabilities
  • Data export and integration

Phase 4: SDKs and tools (2027)​

  • Official SDKs (Python, JavaScript, C#, PHP)
  • CLI tools
  • Integration templates
  • Advanced developer tools

Join the beta program​

Interested in early API access?

Beta partner requirements:

  • Active exclusive partnership
  • Significant case volume
  • Technical team ready to integrate
  • Commitment to provide feedback

How to apply:

  1. Contact your Debitura account manager
  2. Complete technical questionnaire
  3. Sign beta agreement
  4. Receive sandbox credentials
  5. Begin integration

Beta benefits:

  • Early access to API
  • Influence on feature development
  • Priority support
  • Reduced pricing during beta

Stay updated​

Get notified about API development:

  • Subscribe to partner newsletter
  • Join developer community (coming soon)
  • Attend partner webinars
  • Follow API changelog

Email api@debitura.com to express interest or ask questions about the upcoming API.

Next steps​

While waiting for API access:

  • Review current portal capabilities
  • Document your integration requirements
  • Plan your automation workflows
  • Assess development resources needed

Explore other collection partner guides: