Payment Invitations

Create Rent Payment Invitation

Create a payment invitation.

POST /v2/rent-payments

Request Body
  {
      "serviceId": string,
      "amount": number,
      "account": string,
      "type": RESERVATION_FEE|DEPOSIT|MONTHLY_FEE|ADMINISTRATION_FEE,
      "description": string,
      "forDate": string,
      "referenceId": string,
      "callbackUrl": string,
      "payerEmail": string,
      "communicationLanguage": pl|en|ua
  }
Success Response
{
  "paymentUrl": string
}
Example Request
curl --location --request POST 'https://api-test.simpl.rent/v2/rent-payments' \
--header 'Authorization: <API key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "serviceId": "123",
    "amount": 2000,
    "account": "27114020040000300201355387",
    "type": "DEPOSIT",
    "description":"Kaucja 123",
    "referenceId": "12345",
    "callbackUrl": "simpl.rent",
    "email":"test@simpl.rent"
}'

Get Rent Payment Status

GET /v2/rent-payments/:referenceId

referenceId - string referenceId ID on creating the invitation.

Success Response
  {
    "referenceId": string,
    "status": NEW|PENDING|PAID|FAILED|CANCELED,
    "paidAmount": number
  }
Example Request
curl --location --request GET 'https://api-test.simpl.rent/v2/rent-payments/123' \
--header 'Authorization: <API key>'
Insurance InvitationsIntroduction