Get Started

Welcome to Payr

Welcome to the Payr Third-Party Integration documentation. This guide will help you integrate Payr's rent payment solution into your platform.

What is Payr?

Payr enables your users to pay their rent by card through an embedded payment interface. With our API, you can:

• Onboard users with their tenancy details and KYC documents

• Create payment sessions for seamless rent payments

• Embed our payment iframe directly into your platform

• Receive webhooks for real-time payment notifications

---

Quick Start

Get up and running with Payr in four simple steps.

1. Get Your API Credentials

Contact [email protected] to request your API credentials. You'll receive:

• A Server API Token for server-to-server authentication

• Access to the Sandbox environment for testing

2. Onboard Your Users

Call the /onboarding/ endpoint to register users with their:

• Personal details (name, email, phone, date of birth)

• Tenancy information (address, rent amount, payment schedule)

• KYC documents (ID front/back, selfie)

curl -X POST https://sandbox-api.mypayr.co.uk/thirdparty/onboarding/ \
  -H "Authorization: Token your_server_token" \
  -H "Content-Type: application/json" \
  -d '{
    "student_id": 12345,
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Smith",
    ...
  }'

3. Create a Payment Session

When a user wants to pay rent, call /user-login/ to create a payment session:

curl -X POST https://sandbox-api.mypayr.co.uk/thirdparty/user-login/ \
  -H "Authorization: Token your_server_token" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

This returns a token valid for 15 minutes.

4. Display the Payment Interface

Embed the Payr iframe using the token from step 3:

<iframe
  src="https://sandbox.mypayr.co.uk/third-party?token={token}&session_id={session_id}"
  width="100%"
  height="700"
  frameborder="0"
  allow="payment"
></iframe>

The user can now complete their rent payment within your platform.

---

Next Steps

• Iframe Integration — Learn how to embed the payment interface

• Authentication — Understand token types and rotation

• Onboarding — Full field reference for user registration

• Payment Session — Create and manage payment sessions

---

Need Help?

Contact [email protected] for:

• API credentials and webhook configuration

• Sandbox environment access

• Integration support and troubleshooting