Skip to main content

Test Cases

Create cases in production without triggering real collection activity by setting IsTest: true.

How It Works​

When you create a case with IsTest: true, Debitura:

  • Validates the request exactly like a production case
  • Persists the case to your account
  • Does not assign it to a collection partner
  • Does not send any emails (to debtor, creditor, or partners)
  • Does not sync to external systems
  • Excludes it from all metrics and reporting
  • Hidden from partner views - Test cases never appear in collection partner case lists or digest emails, even if a CollectionPartnerId is assigned

Test cases are for integration testing and validation. They cannot be converted to production cases.

Example​

POST /v1/cases
Content-Type: application/json
XApiKey: YOUR_API_KEY

{
  "isTest": true,
  "currencyCode": "USD",
  "amountToRecover": 1500.00,
  "date": "2025-08-01",
  "debtor": {
    "type": "Company",
    "name": "Test Company Ltd",
    "address": "123 Test Street",
    "city": "London",
    "countryAlpha2": "GB"
  }
}

Identifying Test Cases​

In API responses, test cases include "isTestCase": true:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isTestCase": true,
  "status": "Active"
}

Use the isTestCase field to filter test data in your application.

Cleanup​

Test cases may be periodically cleaned up by Debitura. Do not rely on test cases persisting indefinitely.

Applies To​