Integration Flows

Payment Flow With Onboarding (First time user)

Steps

1. Onboard the user — POST /onboarding/ with user details, tenancy, KYC documents, and installments (if applicable). This is typically done once per user.

2. Create a payment session — POST /user-login/ with the user's email. Return URL contain a token (valid 15 hours) and session_id (valid 30 minutes).

3. Display the payment interface — Embed or redirect to the Payr iframe using the token and session_id.

4. User completes payment — The user interacts with the iframe to pay their rent.

5. Receive webhook — Payr sends a webhook to your configured endpoint with the payment outcome.

6. Query session (optional) — GET /session/{session_id}/ to check session and payment details.

---

Payment Flow (Returning User)

Steps

1. Create a payment session — POST /user-login/ with the user's email. Return URL contain a token (valid 15 hours) and session_id (valid 30 minutes).

2. Display the payment interface — Embed or redirect to the Payr iframe using the token and session_id.

3. User completes payment — The user interacts with the iframe to pay their rent.

4. Receive webhook — Payr sends a webhook to your configured endpoint with the payment outcome.

5. Query session (optional) — GET /session/{session_id}/ to check session and payment details.

---