POST/api/public/access-request/paypal/create-order

Creates a PayPal order for the selected package.

Send the package code in the `package` field and optionally the applicant's `email`. The amount is determined on the server side from the package only. On success, the `data` object of the response contains the PayPal order ID `order_id` as well as `amount_cents` and `currency`; with the `order_id`, the buyer approves the payment in the PayPal checkout. You then complete the payment with `POST /api/public/access-request/paypal/capture-order`. An invalid package results in 400 `INVALID_PACKAGE`, an invalid email address in 400 `INVALID_EMAIL`. If PayPal is currently unavailable, the endpoint responds with 503 `PAYPAL_NOT_READY`. The endpoint is limited to 10 requests per 15 minutes per IP address. Every successful call creates a new order, so do not retry it automatically.

Overview

Call: POST /api/public/access-request/paypal/create-order. This endpoint belongs to the “Public Forms” group of the Zentor App API. It is publicly accessible and requires no authentication. The call is not idempotent: every successful call triggers the action again. Required parameters: package (body). Documented error cases: 503 PAYPAL_NOT_READY. The example response below shows the structure of a successful JSON response.

Auth & Security

No authentication required

Idempotent: No

Parameters

package(body, string, required)— Package code of the selected package

Example Request

{"package":"starter"}

Example Response

{"ok":false,"error":"PAYPAL_NOT_READY","message":"PayPal ist derzeit nicht verfügbar."}

Error Codes

503 PAYPAL_NOT_READY — PayPal is currently unavailable.

Verified behaviour

Without an available PayPal connection, the call returns 503 `PAYPAL_NOT_READY`. The success case requires a real payment via PayPal.

Public Forms

POST /api/public/contactAccepts a request from the contact form on the Zentor App website and forwards it to the Zentor team.POST /api/public/consultationAccepts a consultation request from the form on the Zentor App website.POST /api/public/access-requestSubmits an access request for a package (Starter, Individuell or 14-day demo). A previously confirmed email address is required.POST /api/public/access-request/email/start-verificationSends a six-digit confirmation code, valid for 10 minutes, to the given email address – the first step of an access request.POST /api/public/access-request/email/verifyChecks the code delivered by email and issues a confirmation token for the subsequent access request.GET /api/public/access-request/payment-statusIndicates which payment methods (PayPal, Stripe) are currently available for the access request.GET /api/public/access-request/paypal/configReturns the public PayPal configuration (enabled, mode, currency) for the payment step.POST /api/public/access-request/paypal/capture-orderCompletes (captures) a previously created order that the buyer has approved in the PayPal checkout. The amount is set by the server alone.POST /api/public/access-request/stripe/create-checkoutCreates a Stripe checkout session for the selected package.POST /api/public/activate-accountActivates a newly created user account and sets the first password – triggered via the link in the invitation email.

Related articles

← Public Forms