This page explains what the CasaPay Partner API covers and how to get started. Specific endpoint details, authentication schemes, and response schemas are not published here — they are scoped and shared with you during partner onboarding, once the relevant modules and integration approach have been agreed.
What the API covers
RentLink
Create tenant-ready payment requests, track payment status in real time, and keep reconciliation context tied to the right tenant and property. The foundation of the CasaPay operator workflow.
CasaPay Offers
List homes and connect CasaPay members with operator properties. Help operators reach prospective tenants who are already verified and ready to move.
CasaPay Capital
Connect eligible operators to financing options through CasaPay’s third-party Capital partner. Capital is subject to assessment and applicable terms — it is not guaranteed funding.
Module availability for each API area — RentLink, Offers, and Capital — requires product validation as part of the partner onboarding process. Not every module may be available at launch or in every market.
Integration paths
CasaPay supports three integration approaches so you can choose the model that fits your platform’s technical resources and your operators’ readiness.Direct API
Full programmatic access for platforms with in-house engineering resources. Connect your platform directly to CasaPay’s API, control the user experience end-to-end, and build the integration into your existing product workflow.
Assisted no-code
For platforms where operators aren’t ready for a full API integration. CasaPay provides assisted onboarding tools that let operators access RentLink functionality without requiring your platform to complete a full API build first. A route to activation while the deeper integration is scoped.
Embedded
Embed CasaPay flows directly in your platform’s UI. Rather than sending operators out to a separate CasaPay interface, embedded integration lets you surface RentLink and other CasaPay functionality inside your own product — keeping your platform at the centre of the operator’s workflow.
Getting started with the API
1
Apply for partner access
Reach out to CasaPay to express your interest in the Platform Partner Programme. You will be asked about your platform, the operators you serve, and the workflows you want to improve. This is the starting point for scoping the integration.
2
Scope your integration during onboarding
During the partner onboarding process, CasaPay works with you to agree which API modules are relevant, which integration path fits your platform, the launch support terms, and the commercial model. API documentation and technical specifications are shared at this stage.
3
Validate and launch together
Once the integration is built, CasaPay validates it against the agreed criteria before you go live. The validation process checks integration functionality, operator onboarding readiness, and support capability. After passing validation, you launch — and qualifying active units begin generating Partner Revenue Share.
Ready to integrate? Contact CasaPay at support@casapay.com to begin the platform partner onboarding process and scope your API integration. You can also book a conversation directly with the CasaPay partnerships team.
Frequently asked questions
Does one API really cover RentLink, Offers, and Capital?
Does one API really cover RentLink, Offers, and Capital?
That is the proposed platform-partner scope: a unified API covering rent payments and reconciliation through RentLink, rental listings and tenant discovery through CasaPay Offers, and capital options for eligible operators through CasaPay Capital. The availability of each module needs product validation before launch. You and CasaPay agree which modules are in scope during the partner onboarding process.
Where can I find endpoint documentation?
Where can I find endpoint documentation?
API endpoint documentation, authentication details, and response schemas are shared during the partner onboarding process — once your integration scope and applicable modules have been agreed. They are not published openly, as the integration is scoped individually for each platform partner.
Can we start with just RentLink and add modules later?
Can we start with just RentLink and add modules later?
Yes. The most common starting point is RentLink — it is the foundation of the CasaPay operator workflow and the module that generates Partner Revenue Share. You can scope additional modules such as Offers and Capital during or after the initial integration, subject to availability and the terms of your agreement.
What support does CasaPay provide during the integration build?
What support does CasaPay provide during the integration build?
CasaPay provides launch support as part of the partner programme — up to £7,500, staged against agreed milestones and recoupable from future Partner Revenue Share. Technical support, documentation access, and integration guidance are all provided during the scoping and build phase. The exact scope of support is agreed during onboarding.