Payment Invitation

Create Rent Payment Invitation

POST/v2/rent-payments

Create a payment invitation.

Request body

referenceIdstringRequired

Unique ID to reference the payment invitation.

serviceIdstringRequired

Service that should be used for processing payment (if there are more than one service available).

amountnumberRequired

Decimal amount to be paid, greater than 0.

accountstringRequired

Polish bank account for transferring the money. Validation regexp: ^(?!94109013910000000136446495|57105015331000009700154389)^([0-9]{26})$

typestringRequired

Payment type (RESERVATION_FEE|DEPOSIT|MONTHLY_FEE|ADMINISTRATION_FEE)

descriptionstringRequired

Transfer description. Validation regexp: ^.{1,79}$

forDatestringOptional

Additional year-month date for types [MONTHLY_FEE]. Format: yyyy-MM

payerEmailstringOptional

Email address to send an email with payment invitation by simpl.rent.

communicationLanguagestringOptional

Default: pl. Language for initial tenant mailing and flow communication.

callbackUrlstringOptional

Callback URL for process updates (see rent payment status object).

Returns

paymentUrlstring

URL to the payment page.

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/{id}

Get the status of a rent payment.

Path parameters

idstring

Unique ID (referenceId) provided when creating the invitation.

Returns

Returns rent payment status object.

Example Request


curl --location --request GET 'https://api-test.simpl.rent/v2/rent-payments/123' \
--header 'Authorization: <API key>'

Rent Payment Status Object

Callback object for payment process updates.

referenceIdstring

Unique ID to reference the payment invitation.

statusstring

Payment status (NEW|PENDING|PAID|FAILED|CANCELED).

paidAmountnumber

Paid amount.