REST API

Build with CasaPay

Integrate rent collection, tenant screening, guarantees, and invoicing into your platform with our REST API.

View API Docs Get API Keys

Core API Endpoints

POST /v1/payment_agreements

Create recurring payment agreements for rent collection via card, bank, or open banking.

View docs →
POST /v1/verification_sessions

Run identity, income, credit, and cash flow checks. Get a 0-100 risk score.

View docs →
POST /v1/email_aliases

Create @casapay.me aliases for zero-integration invoice forwarding and payment collection.

View docs →
POST /v1/guarantee_policies

Create payment guarantee agreements. Reactive or proactive coverage, with deposit elimination.

View docs →
POST /v1/collection_cases

Query and track automated debt recovery cases across 183 countries.

View docs →
GET /v1/tenants/:id

Retrieve tenant details, screening results, payment history, and active agreements.

View docs →

Quick Start

1

Get your API keys

Sign up at op.casapay.com and generate test/live API keys from the dashboard.

2

Make your first API call

All endpoints use Bearer token authentication:

curl https://api.test.casapay.com/v1/tenants \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json"
3

Go live

Switch to live API keys when you're ready. Same endpoints, real payments.

API Reference

Complete endpoint documentation with request/response examples.

Webhooks

Real-time event notifications for payments, screening results, and claims.

Testing

Sandbox environment with test API keys for safe development and integration testing.