Case Previews#

Case Previews let you check eligibility and get pricing estimates before submitting a collection case. This helps you understand fees and requirements upfront.

The Case Preview object#

Attribute	Type	Description
`is_eligible`	boolean	Whether the case can be submitted
`ineligibility_reason`	string	Why the case is not eligible (if applicable)
`partner_assignment`	object	Assigned collection partner details
`partner_assignment.partner_id`	string	Partner ID
`partner_assignment.partner_name`	string	Partner name
`partner_assignment.partner_country`	string	Partner country
`required_actions`	array	Actions required before submission
`required_actions[].type`	string	Action type
`required_actions[].message`	string	Action description
`required_actions[].solution_url`	string	URL to resolve the action
`required_actions[].is_blocking`	boolean	Whether this blocks submission
`pricing_preview`	object	Fee structure
`pricing_preview.base_success_fee_pct`	number	Base success fee percentage
`pricing_preview.age_surcharge_pct`	number	Surcharge for aged debts
`pricing_preview.total_success_fee_pct`	number	Total success fee percentage

{
  "is_eligible": true,
  "ineligibility_reason": null,
  "partner_assignment": {
    "partner_id": "cp_partner_de_01",
    "partner_name": "CollectMax GmbH",
    "partner_country": "DE"
  },
  "required_actions": [],
  "pricing_preview": {
    "base_success_fee_pct": 12.5,
    "age_surcharge_pct": 2.0,
    "total_success_fee_pct": 14.5
  }
}

Create a Case Preview#

POST /v1/collection_case_previews

Parameter	Type	Required	Description
`amount_to_recover`	integer	Yes	Debt amount
`currency`	string	Yes	ISO 4217 currency code
`debtor`	object	Yes	Debtor info (type, name, country)
`due_date`	string	Yes	Original due date

curl https://api.casapay.com/v1/collection_case_previews \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_to_recover": 360000,
    "currency": "eur",
    "debtor": {
      "type": "private",
      "name": "John Smith",
      "country": "DE"
    },
    "due_date": "2024-11-01"
  }'

Ineligible Response Example#

{
  "is_eligible": false,
  "ineligibility_reason": "No collection partner available for the specified jurisdiction",
  "partner_assignment": null,
  "required_actions": [
    {
      "type": "contract_signing",
      "message": "You need to sign the collection agreement first",
      "solution_url": "https://dashboard.casapay.com/contracts/sign",
      "is_blocking": true
    }
  ],
  "pricing_preview": null
}