DEdebitura
ManagedCases

Preview managed-case routing.

Changed on

Optional, read-only snapshot. HasPreLegalPartner describes a routing candidate, not permission to create a case. No match may lead to internal review and potentially network quotes on submission; neither acceptance nor a quote is guaranteed. Full validation, agreements and admission rules still apply on creation. No client, case or routing reservation is created by this endpoint. Send outstanding principal, currency and debtor type/country/state; invoice lines and pricing inputs are not evaluated. Model-binding errors use ValidationProblemDetails.

marketMinimumAmount is the smallest claim the market takes for this debtor country and type (never below the platform minimum of 100 USD). applicableMinimumAmount is not populated by this endpoint.

Examples

Matched — request {"amountToRecover": 15000, "currencyCode": "USD", "debtor": {"type": "Company", "countryAlpha2": "US", "stateAlpha2": "NY"}} → response {"hasPreLegalPartner": true, "collectionPartnerId": "...", "routingSource": "Automatic", "marketMinimumAmount": 500, "marketMinimumCurrencyCode": "USD"}.

No match, amount below minimum — request {"amountToRecover": 175, "currencyCode": "USD", "debtor": {"type": "Company", "countryAlpha2": "US", "stateAlpha2": "NY"}} → response {"hasPreLegalPartner": false, "ineligibilityReasonCode": "AmountBelowMinimum", "marketMinimumAmount": 500, "marketMinimumCurrencyCode": "USD"}.

No match, no geographic coverage — request {"amountToRecover": 2000, "currencyCode": "USD", "debtor": {"type": "Company", "countryAlpha2": "VN"}} → response {"hasPreLegalPartner": false, "ineligibilityReasonCode": "NoGeographicCoverage", "marketMinimumAmount": null}.

Excluded for this client — request with a clientId excluded from every remaining candidate → response {"hasPreLegalPartner": false, "ineligibilityReasonCode": "ExcludedForClient"}.

Explicit override — request {"amountToRecover": 2000, "currencyCode": "USD", "collectionPartnerId": "(a partner id)", "debtor": {...}} → response {"hasPreLegalPartner": true, "collectionPartnerId": "(the same id)", "routingSource": "Requested"}.

Degraded FX — an unquotable request currency still returns a selected candidate where one exists: response {"hasPreLegalPartner": true, "routingSource": "Automatic", "ineligibilityReasonCode": "EligibilityUndetermined", "amountCheckUnavailable": true, "marketMinimumAmount": null}.

post/managed-cases/preview

Request

  • Base URL
    https://collectionpartner-api.debitura.com
  • URL
    https://collectionpartner-api.debitura.com/managed-cases/preview
  • Auth
    API key in header XApiKey

Request body

amountToRecovernumber double required

Positive outstanding principal in CurrencyCode. For invoice lines, send their summed outstanding balance.

currencyCodestring required

Supported three-letter ISO currency code, for example USD or EUR.

clientIdstring uuid nullable

Optional represented client owned by your partner account. Omit to preview a new inline client without creating one.

collectionPartnerIdstring uuid nullable

Optional explicit receiving partner. Takes precedence over automatic and test-case routing.

isTestboolean

Preview test routing. Without an explicit receiving partner, test/demo cases route to your own partner account.

Response

OK

hasPreLegalPartnerboolean

Whether a routing destination is selected now. Does not certify acceptance of the case.

collectionPartnerIdstring uuid nullable

Selected candidate, or null when no pre-legal partner was selected.

routingSource'Automatic' | 'ClientConfigured' | 'Requested' | 'SelfManaged' | 'null' nullable

How the candidate was selected. Null when no candidate was selected.

ineligibilityReasonCodestring nullable

Stable matching reason code. May be EligibilityUndetermined even with a selected candidate when amount checks were unavailable.

ineligibilityReasonstring nullable

Matching diagnosis, not a refusal of case admission.

applicableMinimumAmountnumber double nullable

Not populated by this endpoint (always null): a managed claim without a partner is not refused, and no amount is suggested. Use MarketMinimumAmount for the market floor.

applicableMinimumCurrencyCodestring nullable

Always null on this endpoint; see ApplicableMinimumAmount.

marketMinimumAmountnumber double nullable

Smallest claim the marketplace takes for this jurisdiction and debtor type, in the request currency: the lowest partner floor, never below the platform minimum of 100 USD. A market statement, returned whether or not a partner is selected. Not the admission rules applied when a case is created. Null when no partner covers the market or the amount cannot be priced (see AmountCheckUnavailable).

marketMinimumCurrencyCodestring nullable

Currency of MarketMinimumAmount.

amountCheckUnavailableboolean

Amount conditions could not be fully evaluated. May be true even when a candidate is selected.

Changes

  • 3b5344b912baRevision changes
    • info

      api tag ManagedCases added

    • info

      api tag ManagedCasePreview removed

  • f8145be751d0Revision changes
    • breaking

      the response property became nullable for the status (media type: text/plain)

    • breaking

      the response property became nullable for the status (media type: application/json)

    • breaking

      the response property became nullable for the status (media type: text/json)

    • warning

      added the new undefined enum value to the response property for the response status (media type: text/plain)

    • warning

      added the new undefined enum value to the response property for the response status (media type: application/json)

    • warning

      added the new undefined enum value to the response property for the response status (media type: text/json)