Introduction#
The CasaPay API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
You can use the CasaPay API in test mode, which doesn't affect your live data. The API key you use to authenticate the request determines whether the request is live mode or test mode.
Base URL#
All API requests should be made to:
https://api.casapay.com/v1Products#
CasaPay offers seven products, each with its own set of API endpoints:
| Product | Description |
|---|---|
| Tenant Verification | Verify tenant identity, income, credit history, and cash flow |
| Tenant Scoring | Generate risk scores with adverse action codes |
| Invoicing | Create, send, and manage rental invoices |
| Payments — Collection | Collect payments via cards, open banking, and direct debit |
| Payments — Payouts | Disburse funds to landlords and property managers |
| Payments — Guarantee | Offer rent guarantees with configurable policies |
| Payments — Debt Collection | Manage debt recovery with collection partners |
Request IDs#
Each API request has an associated request identifier. You can find this value in the response headers, under X-Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request ID will ensure the fastest possible resolution.
Client Libraries#
CasaPay provides official client libraries in multiple languages:
# Node.js
npm install casapay
# Python
pip install casapay
# Ruby
gem install casapay
# Go
go get github.com/casapay/casapay-go
# PHP
composer require casapay/casapay-php
# Java
// Maven
<dependency>
<groupId>com.casapay</groupId>
<artifactId>casapay-java</artifactId>
</dependency>
# .NET
dotnet add package CasaPay