Payments Guarantee Quickstart#

Offer rent guarantees to landlords, covering missed payments with configurable policies and automated claims processing.

Step 1: Create a Guarantee Policy#

Define the terms of your guarantee coverage:

curl https://api.casapay.com/v1/guarantee_policies \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Standard Rent Guarantee",
    "coverage_percentage": 100,
    "max_coverage_months": 12,
    "waiting_period_days": 30,
    "eligible_score_minimum": 60
  }'

Step 2: Create a Guarantee#

Activate a guarantee for a specific tenant and property:

curl https://api.casapay.com/v1/guarantees \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "policy": "gpol_abc123",
    "tenant": "cus_123456789",
    "coverage_amount": 120000,
    "currency": "eur",
    "start_date": 1706140800,
    "end_date": 1737676800,
    "metadata": {
      "property_id": "prop_456",
      "lease_id": "lease_789"
    }
  }'

{
  "id": "grt_def456",
  "object": "guarantee",
  "status": "active",
  "policy": "gpol_abc123",
  "tenant": "cus_123456789",
  "coverage_amount": 120000,
  "currency": "eur",
  "start_date": 1706140800,
  "end_date": 1737676800,
  "created": 1706140800
}

Step 3: File a Claim#

When a tenant misses a payment, file a claim against the guarantee:

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"
    }
  }'

{
  "id": "clm_ghi789",
  "object": "claim",
  "guarantee": "grt_def456",
  "amount": 120000,
  "status": "under_review",
  "reason": "missed_payment",
  "created": 1706140800
}

Claims are typically reviewed and paid within 5 business days. You'll receive a claim.approved or claim.denied webhook event.