How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Debitura Collection Partner API

For collection agencies operating cases on the platform. Managed cases, bulk ingestion jobs, and the user and webhook surface behind them. 48 operations across 38 paths, OpenAPI 3.0.4 with 68 component schemas. Authenticates with an API key in the XApiKey header.

This API exposes 48 operations across 38 paths, organized into 9 resource areas, and defines 68 schemas. It is described by OpenAPI 3.0.4, at version v1.

Requests are made against a single base URL, https://collectionpartner-api.debitura.com.

48 operations 38 paths 68 schemas 5 DELETE25 GET14 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
v1
Base URL
https://collectionpartner-api.debitura.com
Authentication
API Key
Resource Areas
9

Authentication & Security 1

Debitura Collection Partner API declares 1 security scheme for authenticating requests. An API key is passed in the header as XApiKey (ApiKey). By default, every request must be authenticated.

  • ApiKey — Collection Partner API Key (use XApiKey header)

Paths & Operations 48

Across 38 paths, the API surfaces 48 operations — 5 DELETE, 25 GET, 14 POST, 4 PUT. They span 9 resource areas: Cases, IngestionJobs, ManagedCases, Me, TestCases, TestWebhooks, Users, WebhookEvents, Webhooks. Each is listed below with its method, path, parameters, and response codes.

Cases 21

Cases

GET
/cases
List collection cases.
8 params → 200400
GET
/cases/{id}
Fetch case by ID
1 param → 200400404
GET
/cases/case-reference/{caseReference}
Fetch case by reference
1 param → 200400404
GET
/cases/by-partner-reference/{reference}
Fetch a single case by the collection partner's own reference ID.
1 param → 200400404
GET
/cases/by-partner-reference
Batch lookup of cases by the collection partner's own reference IDs.
1 param → 200400
GET
/cases/by-creditor-reference
Fetch a single case by creditor reference, scoped to a specific creditor and partner.
2 params → 200400404
GET
/cases/{id}/timeline
Fetch case timeline
1 param → 200400404
GET
/cases/{id}/chats
Fetch case chats
1 param → 200400404
POST
/cases/{id}/chats
Send a chat message on a case
2 params body → 200400404500
GET
/cases/{id}/payments
Fetch case payments
1 param → 200400404
POST
/cases/{id}/payments
Create a payment on a case
2 params body → 200400404409422500
GET
/cases/{id}/files
Get case files
1 param → 200400404500
POST
/cases/{id}/files
Upload a file to a case
1 param body → 200400404409413415500
POST
/cases/{id}/notes
Create a note on a case
1 param body → 200400404500
PUT
/cases/{id}/payments/{paymentId}
Edit a payment on a case
2 params body → 200400404409422500
DELETE
/cases/{id}/payments/{paymentId}
Delete a payment on a case
3 params → 204400404409422500
POST
/cases/{id}/close
Close a case
1 param body → 200400404500
POST
/cases/{id}/start
Activate a case from PendingVerification
1 param body → 200400404500
PUT
/cases/{id}/fees
Update case fees and/or principal
1 param body → 200400404409500
GET
/cases/{id}/exclusive-period
Get exclusive collection period chain
1 param → 200400404
GET
/cases/{id}/validation
Get full validation detail for a case
1 param → 200400404
IngestionJobs 2

IngestionJobs

POST
/ingestion-jobs
Enqueue a batch of partner ingest events (notes, payments, status updates).
1 param body → 202400
GET
/ingestion-jobs/{jobId}
Poll the status of a previously submitted ingestion job.
1 param → 200404
ManagedCases 11

Managed Cases

POST
/managed-cases
Create case as managing partner
1 param body → 200400422500
GET
/managed-cases
List managed cases
7 params → 200400
GET
/managed-cases/{id}
Fetch managed case by ID
1 param → 200400404
GET
/managed-cases/case-reference/{caseReference}
Fetch managed case by reference
1 param → 200400404
GET
/managed-cases/{id}/timeline
Fetch managed case timeline
1 param → 200400404
GET
/managed-cases/{id}/chats
Fetch managed case chats
1 param → 200400404
GET
/managed-cases/{id}/payments
Fetch managed case payments
1 param → 200400404
POST
/managed-cases/{id}/payments
Record a payment on a test case (managing partner)
1 param body → 200400404500
PUT
/managed-cases/{id}/payments/{paymentId}
Edit a payment on a test case (managing partner)
2 params body → 200400404409422500
DELETE
/managed-cases/{id}/payments/{paymentId}
Delete a payment on a test case (managing partner)
3 params → 204400404409422500
GET
/managed-cases/{id}/files
Get managed case files
1 param → 200400404500
Me 1

Collection Partner Profile

GET
/me
Verifies the provided API key and returns the collection partner profile
→ 200401404500
TestCases 4

Test Cases

POST
/test/cases/{id}/advance
Advance a test case to a known lifecycle state.
1 param body → 200400404500
DELETE
/test/cases/{id}
Hard-delete a single test case by ID.
1 param → 204400404500
DELETE
/test/cases
Hard-delete all test cases with the given tag.
1 param → 204400500
POST
/test/cases/{id}/replay-last-event
Replay the most recent webhook event for a test case.
1 param → 200400404
TestWebhooks 1

Test Webhooks

POST
/test/webhooks/fire
Fire a named webhook event type for a test case.
body → 200400404422500
Users 1

Users

GET
/users
Lists team members belonging to the authenticated collection partner.
2 params → 200400401500
WebhookEvents 2

Webhooks

GET
/webhooks/events
List webhook events dispatched for a case.
2 params → 200400
POST
/webhooks/events/{id}/replay
Replay a specific webhook event.
1 param → 200400404
Webhooks 5

Manage webhook subscriptions and inspect the delivery event log. Create subscriptions to receive real-time notifications for case lifecycle events, payments, and chats. Use GET /w…

GET
/webhooks
List all webhook subscriptions for the authenticated collection partner.
→ 200401
POST
/webhooks
Create a new webhook subscription.
body → 201400401422
GET
/webhooks/{id}
Get a specific webhook subscription by ID.
1 param → 200401404
PUT
/webhooks/{id}
Update an existing webhook subscription.
1 param body → 200400401404
DELETE
/webhooks/{id}
Delete a webhook subscription.
1 param → 204401404

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceDto (37 properties), Debitura.Web.CollectionPartnerApi.Models.Me.CollectionPartnerMeResponse (21 properties), Debitura.Web.ExternalApi.Contracts.V1.Cases.BankAccountDto (16 properties), Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CreateManagedCaseRequest (14 properties). Each schema is shown below with its type and property counts.

Debitura.Domain.Model.AsyncJobs.AsyncJobStatus
integer
Debitura.Domain.Model.Base.PageData
object
5 properties
Debitura.Domain.Model.CollectionPartnerLogics.CollectionPartners.SurveyCadenceMode
integer
Debitura.Domain.Model.CommunicationCenter.Chats.ChatRole
integer
Debitura.Domain.Model.InvoicePayments.Payouts.CommissionType
integer
Debitura.Domain.Model.PartnerIngest.PartnerIngestEventType
integer
Debitura.Domain.Model.Webhooks.Dtos.CreateWebhookRequest
object
3 properties 2 required
Debitura.Domain.Model.Webhooks.Dtos.UpdateWebhookRequest
object
5 properties
Debitura.Domain.Model.Webhooks.Dtos.WebhookDto
object
9 properties
Debitura.Domain.Services.CaseValidation.CaseValidationItemDto
object
2 properties
Debitura.Domain.Services.CaseValidation.CaseValidationLeanDto
object
1 property
Debitura.Domain.Services.CaseValidation.CaseValidationStatusDto
object
3 properties
Debitura.Web.CollectionPartnerApi.Controllers.CreateIngestionJobRequest
object
1 property
Debitura.Web.CollectionPartnerApi.Controllers.CreateIngestionJobResponse
object
2 properties
Debitura.Web.CollectionPartnerApi.Controllers.IngestionJobRow
object
5 properties
Debitura.Web.CollectionPartnerApi.Controllers.IngestionJobStatusResponse
object
4 properties
Debitura.Web.CollectionPartnerApi.Models.Me.CollectionPartnerMeResponse
object
Response containing collection partner profile information.
21 properties
Debitura.Web.CollectionPartnerApi.Models.Webhooks.ReplayEventResultDto
object
Result of replaying a specific webhook event.
3 properties
Debitura.Web.CollectionPartnerApi.Models.Webhooks.WebhookEventDto
object
Represents a recorded webhook delivery event.
10 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.AdvanceTestCaseResponse
object
Response from POST /test/cases/{id}/advance.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.AssignedUserDto
object
Represents the creditor team member assigned to a case.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BankAccountDto
object
Bank account information for partner API. Full details provided as partners need this to: 1. Provide payment instructions to debtors (when debtor pays client d…
16 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BusinessErrorApiDTO
object
Represents a business error in the API response.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BusinessErrorResponseApiDTO
object
Response returned when business rule violations prevent case creation.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.CaseTimelineResponse
object
Response envelope for GET /cases/{id}/timeline. Wraps the chronological event list with case-level context that cannot be expressed as a single timeline entry.
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.CloseCaseResponse
object
Response after closing a case
9 properties 3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.ClosedByDto
object
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.CollectionPartnerDto
object
V1 Collection Partner DTO for external partner APIs
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.CreditorDivisionDto
object
Creditor division information for external partner APIs. Represents a specific division or department within a creditor organization.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.CreditorDto
object
Creditor (client) information for external partner APIs. Represents the party that the debtor owes money to.
11 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.DebtorDto
object
V1 Debtor DTO for external partner APIs. The debtor is the party that owes the debt.
13 properties 2 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.ExclusivePeriodDto
object
Full exclusive collection period chain for a case. Returned by GET /cases/{id}/exclusive-period.
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.ExclusivePeriodExtensionDto
object
A single extension event in the exclusive period chain.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.FireWebhookResponse
object
Result of the POST /test/webhooks/fire endpoint.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceAllocationOutstandingDto
object
Additive external-API read model. Per-bucket outstanding on the debt ledger, produced by the payment allocation engine (bucket total minus Σ active stored allo…
4 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceDto
object
V1 Invoice DTO for external partner APIs
37 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceListDto
object
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.PriceChangeConfirmationResponse
object
Returned with HTTP 409 when a principal edit would move the case success fee by more than the allowed threshold (0.1 percentage points), or would affect a deli…
7 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.ReplayLastEventResponse
object
Result of the POST /test/cases/{id}/replay-last-event convenience endpoint.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.AdvanceTestCaseRequest
object
Request to advance a test case to a known lifecycle state.
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CloseCaseRequest
object
Request to close a case
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CreateManagedCaseRequest
object
Request model for creating a case as a managing partner. The partner submits both creditor information and case details in a single request.
14 properties 5 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.FireWebhookRequest
object
Request body for POST /test/webhooks/fire.
3 properties 2 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.StartCaseRequest
object
Request to activate a case from PendingVerification to Active status.
9 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.UpdateCaseFeesRequest
object
Request to update the fee amounts (and optionally the principal) on an active case.
6 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.SigningHandoffDto
object
Partner-facing handoff metadata for a creditor's pending signing chain. Returned on POST /cases responses (422 with pending-signing errors, or 200 with AllowPe…
1 property
Debitura.Web.ExternalApi.Contracts.V1.Cases.StartCaseResponse
object
Response returned when a case is successfully activated.
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.TimelineActorDto
object
Represents the actor (person or system) that performed a timeline action.
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.TimelineItemDto
object
5 properties 3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.UpdateCaseFeesResponse
object
Response returned when case fees (and optionally the principal) are successfully updated.
8 properties
Debitura.Web.ExternalApi.Contracts.V1.Chats.ChatDto
object
8 properties
Debitura.Web.ExternalApi.Contracts.V1.Chats.SendChatRequest
object
Request to send a chat message on a case.
3 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Errors.ApiErrorResponseDto
object
Generic structured error response for API endpoints. Dual-write design: existing fields (Debitura.Web.ExternalApi.Contracts.V1.Errors.ApiErrorResponseDto.Error…
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Files.CaseFileDto
object
10 properties
Debitura.Web.ExternalApi.Contracts.V1.Notes.CreateNoteRequest
object
Request to create a new note on a case
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Notes.NoteCreatedByDto
object
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Notes.NoteDto
object
Note details response
8 properties 3 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.CreateManagedCasePaymentRequest
object
Request to record a payment on a test case as managing partner. Only available for cases created with isTestCase: true.
3 properties 2 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.CreateManagedCasePaymentResponse
object
Response after recording a payment as managing partner on a test case.
6 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.CreatePaymentRequest
object
Request to create a payment on a case. Currency: Payment must be in the same currency as the invoice. Currency is automatically determined from the case and ca…
8 properties 3 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.CreatePaymentResponse
object
Response after creating a payment
13 properties 3 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.PaymentDto
object
9 properties 4 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.PaymentRelatedInvoiceDto
object
3 properties 2 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.UpdatePaymentRequest
object
Request to edit an existing payment on a case. Mirrors the payout-split semantics of Debitura.Web.ExternalApi.Contracts.V1.Payments.CreatePaymentRequest. Curre…
7 properties 3 required
Debitura.Web.ExternalApi.Contracts.V1.Users.CollectionPartnerUserDto
object
A user belonging to the authenticated collection partner's team. Use the Debitura.Web.ExternalApi.Contracts.V1.Users.CollectionPartnerUserDto.Id as the assigne…
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Users.UserListDto
object
2 properties 1 required
Debitura.Web.ExternalApi.Contracts.V1.Users.UserRelationDto
object
6 properties 1 required
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

debitura-collection-partner-api.json Raw ↑
Where this information came from

This is an independent, third-party profile of Debitura Collection Partner API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.