Payment Session

Create temporary payment sessions for onboarded users. The session token is used to authenticate the user in the Payr payment iframe.

Create Payment Session

post

https://sandbox-api.mypayr.co.uk/thirdpartyhttps://api.mypayr.co.uk/thirdparty

/user-login/

Create a temporary payment session token for an onboarded user.

This token is valid for 15 minutes and is used for client-side payment operations. Pass the token to the Payr iframe URL (?token={token}) to enable the user to make rent payments.

Note: The user must have been onboarded via /onboarding/ first, otherwise a 400 error is returned.

Example cURL Request

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

Example Response

{
  "url": "https://sandbox.mypayr.co.uk/third-party?token={token}&session_id={session_id}"
}

Authorizations

TokenAuth

AuthorizationstringRequired

Server-to-server authentication token obtained via the rotate-token endpoint. Include in the Authorization header as: Authorization: Token <your_token>

Body

application/json

emailstring · emailRequired

Email address of the user to create a payment session for

Example: [email protected]

Responses

200

Payment session token created successfully

application/json

400

Bad Request - Invalid email or user not found

application/json

401

Unauthorized - Invalid or expired server token

application/json

post

/user-login/

HTTPcURLJavaScriptPython

POST /thirdparty/user-login/ HTTP/1.1
Host: sandbox-api.mypayr.co.uk
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "email": "[email protected]"
}

Basic login requestStudent email login

{
  "url": "https://sandbox.mypayr.co.uk/third-party?token={token}&session_id={session_id}"
}