Transaction / Create Pre-Authorization

post

https://{tenantUrl}/public-api/actions/transaction/v1.0/{transaction}/create-pre-authorization

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta.

Creates a pre-authorisation — a hold, never an immediate charge — for a pending
ad hoc transaction, using the payment processor set on the transaction (Worldline
or Stripe), and returns what you need to collect the customer's payment. Amount
and currency come from the transaction. Repeated calls return the existing
pre-authorisation instead of creating a second one.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

transaction

integer

required

The transaction ID to which the action will be applied

Body Params

Create-pre-authorization request for a transaction whose payment processor is Worldline.
The pre-authorisation is created as a Worldline hosted-checkout page; the
response returns the URL to redirect the customer to.

processor

string

enum

required

The payment processor of the transaction.

Allowed:

paymentProductId

integer

Worldline payment product id selecting the payment rail (e.g. TWINT, Bancontact).

returnUrl

string

required

URL Worldline redirects the customer back to after completing the hosted-checkout page.

locale

string

Locale used to render the Worldline hosted-checkout page (e.g. "en", "de").

paymentProductFilters

object

Optional Worldline payment-product restrictions applied to the hosted-checkout page.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The pre-authorisation was created, or already existed from an earlier call — repeated calls return the same payment data. The response contains what you need to collect the customer's payment.

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found

409The request could not be completed due to a conflict with the current state of the resource. The operation may succeed if retried.

422The payload you provided is invalid

424The requested operation cannot be completed because it depends on communication with an external system (e.g., charge point) that is currently disconnected or unreachable

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*