Claims#

A Claim is filed against a Guarantee when a tenant defaults on a payment. CasaPay reviews the claim and, if approved, pays the guaranteed amount to the landlord.

The Claim object#

Attribute	Type	Description
`id`	string	Unique identifier with `clm_` prefix
`object`	string	Always `"claim"`
`guarantee`	string	Guarantee ID
`amount`	integer	Claimed amount
`currency`	string	ISO 4217 currency code
`status`	enum	`submitted`, `under_review`, `approved`, `denied`, `paid`
`reason`	enum	`missed_payment`, `partial_payment`, `lease_break`, `property_damage`
`evidence`	object	Supporting evidence
`evidence.invoice_id`	string	Unpaid invoice ID
`evidence.due_date`	timestamp	Payment due date
`evidence.description`	string	Claim description
`payout`	string	Payout ID (when paid)
`denial_reason`	string	Reason for denial (if denied)
`reviewed_at`	timestamp	When the claim was reviewed
`metadata`	hash	Key-value pairs
`created`	timestamp	Time at which the object was created

{
  "id": "clm_ghi789",
  "object": "claim",
  "guarantee": "grt_def456",
  "amount": 120000,
  "currency": "eur",
  "status": "approved",
  "reason": "missed_payment",
  "evidence": {
    "invoice_id": "inv_abc123",
    "due_date": 1708732800,
    "description": "February 2025 rent — unpaid"
  },
  "payout": "po_claim_001",
  "reviewed_at": 1709078400,
  "created": 1708819200
}

Create a Claim#

POST /v1/claims

Parameter	Type	Required	Description
`guarantee`	string	Yes	Guarantee ID
`amount`	integer	Yes	Amount to claim
`currency`	string	Yes	ISO 4217 currency code
`reason`	string	Yes	Claim reason
`evidence`	object	Yes	Supporting evidence

curl https://api.casapay.com/v1/claims \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "guarantee": "grt_def456",
    "amount": 120000,
    "currency": "eur",
    "reason": "missed_payment",
    "evidence": {
      "invoice_id": "inv_abc123",
      "due_date": 1708732800,
      "description": "February 2025 rent — unpaid"
    }
  }'

Retrieve, List#

GET /v1/claims/:id

GET /v1/claims?guarantee=grt_def456