try out ↗

← API Index


/api/client/wero/transaction1

Initiate a Wero (VR Payment) payment. On success returns the bank's landing page the customer must be redirected to for consent.

Change Note: replaces legacy exec1.jsp dispatch for DoWero with POJO pattern

Parameters

Name Description Type
total Wero grand total (currency amount) double
vatsum included Wero total tax double
shipping included Wero total shipping double
count number of order positions int
relvoucherid relative voucher id to apply to the total (0 if none) int
returnPath template-relative path (or absolute domain-root path) of the page the customer lands on after the bank redirects back; a caller with API_WERO_ACCESS may instead pass a full absolute URI, used verbatim - an https:// URL, an http:// one, or a native app's own scheme such as myapp://checkout/done. Anything that isn't https is reached via an https bounce on this domain, because the bank refuses a non-https returnUrl; that hop is transparent to you and the weroReturn=1 marker arrives either way. javascript:/data:/vbscript:/file:/blob:/about: are refused with X-oekobox-error: ERROR. string
description bank-facing payment description, used only for a transaction with no associated shop order string
autoConfirm if true, we own the whole tail of this payment: the return is always proxied through us, consent is verified and the payment captured server-side, and the terminal outcome is posted to the msgqueue table as id 'wero:' (topic 'wero.payment') for you to poll - no /api/wero/confirm1 call needed. The outcome is posted even if the customer never returns to the return URL at all, which is the normal case when the Wero QR code was scanned on a different device than the one that started the checkout. Requires API_WERO_ACCESS (ignored for any other caller) and a transaction with no shop order attached - an order-attached payment is captured by the checkout itself, so that combination is refused with X-oekobox-error: ERROR. Note this endpoint reports failures as HTTP 200 with that header (only not_auth is a real status code), so check the header rather than the status. boolean
werotest if true, this one payment goes to the VR Payment test environment instead of production, so the flow can be rehearsed without moving real money. Requires API_WERO_ACCESS and a transaction with no shop order attached; ignored for any other caller. Applies to this transaction alone - the resulting paymentId stays bound to the test environment for confirm and refund. See the standalone-wero-api skill. boolean
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Error Responses

HTTP Status Error Code Description
409 ERROR Wero authorization could not be initiated (not configured, invalid session/order state, or upstream error)
401 not_auth No associated shop order could be resolved, and the caller lacks the API_WERO_ACCESS permission required to create an orderless transaction

Response Types

Type Version Description
WeroAuthorize 1 Result of starting a Wero (VR Payment) authorization. On success carries the bank's landing page for consent.

OpenAPI

See transaction1.yaml

Referenced in skills