Transactions / Create

post

https://{tenantUrl}/public-api/resources/transactions/v1.0

Create new Transaction

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

operatorId

integer | null

The operator ID for this resource.
Required for global admin tokens when sessionId is not provided.
Optional for operator-scoped tokens (defaults to token's operator).
Ignored when sessionId is provided (operator is derived from the session).

sessionId

integer

The ID of the charging session to associate with this transaction.
Sessions initiated over OCPP (local payment terminal, RFID, plug-and-charge) are eligible,
provided the session belongs to the token's operator.

paymentMethod

object

totalAmount

number

required

0 to 10000000000000

authorizedAmount

number

0 to 10000000000000

The PSP-authorised ceiling for this transaction. When omitted, the platform derives
the value from the purchasable's pre-authorisation configuration.

status

string

enum

required

Allowed:

ref

string

failureReason

string

invoiceRequired

boolean

When set to true and the operator has receipt suppression for invoice issuance enabled,
the receipt will be suppressed for this transaction. This is intended for terminal
transactions where the customer indicates they want an invoice instead of a receipt.

string

Email address for invoice delivery. Conditionally required based on the Email field
configuration in the operator's invoice integration settings:

When set to "Required": This field is mandatory when invoiceDetails is provided.
When set to "Optional": This field is optional; if omitted, the invoice is issued without email notification.
When set to "Disabled": This field must not be provided.
Only applicable when invoiceDetails is provided.

locale

string

ISO language code (e.g., "en", "bg", "de", "pl") for bilingual invoice generation.
When "Issue bilingual invoices" is enabled for the operator, the invoice is generated
in both the operator's configured invoice language (primary) and this locale (secondary).
If not provided, falls back to: user's preferred locale → operator default → tenant default → English.
Only applicable when invoiceDetails is provided.

invoiceDetails

object

Invoice details for automatic ad-hoc invoice issuance upon transaction finalization.
When provided, the system creates an ad-hoc user with stored invoice details and
automatically issues an invoice when the transaction reaches "finalized" status.
This field cannot be updated via PATCH after creation.
The existing issue-invoice endpoint can still be called to override these details
before the invoice is issued.

paymentMetadata

object

Regulatory payment metadata captured from the payment source (terminal or online).
All keys are optional; send only the fields known at write time.

Responses

201Transaction created successfully

401Access token is missing or invalid

403You do not have permission to perform the action

422The payload you provided is invalid

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