Payment Parameters

General

Abbreviations

Abbreviation	Description
CND	condition
M	mandatory - must be presented
O	optional - can be presented, but is not required
C	conditional - a conditional rule that specifies mandatory or optional

Payment Request Parameters

Key	Format	CND	Description
brand	string (enum)	M	name of the payment method - always: `WERO`
amount	decimals (max 2 digits)	M	payment amount, range 0.01 - 100000
currency	string (enum, ISO4217)	M	Currency Code - only EUR
useCase	string	M	sets payment plan type (SINGLE, EVENT_DEPENDENT)
reasonForCapture	string (enum)	O	The reason why a capture is triggered - defaults to `OTHER` (SHIPPING, DELIVERY, AVAILABILITY, SERVICE_FULFILMENT, OTHER)
partialCapture	boolean	O	indicates if the consumer must be charged the complete amount or up to the amount (true/false) - default: true
timeToCapture	integer (1-864000)	O	max time (in seconds) between authorization and capture - default 604800
multiCapture	boolean	O	indicates if multiple captures are allowed - default: true
transactionId	string (max 64 chars)	M	merchant reference string to identify a transaction
returnURL	string (URL)	M	the URL of the shop page where the customer will be redirected to
transactionDescription	string (max 128 chars)	O	description text for a transaction, provided by the merchant
walletId	string (UUID)	O	unique wallet ID of the customer Example: 11111111-2222-3333-4444-555555555555
recipientName	string (max 128 chars)	M	first and last name of the recipient
line1	string (max 300 chars)	M	First line of the billing/shipping address
line2	string (max 300 chars)	O	second line of the billing/shipping address. Used for additional address information
postalCode	string (max 32 chars)	M	postal code of the billing/shipping address
city	string (max 64 chars)	M	city of the billing/shipping address
state	string (max 300 chars)	O	state of the billing/shipping address
country	string (ISO3166-1)	M	country of the billing/shipping address

Payment Capture

Key	Format	CND	Description
paymentId	string (UUID)	M	unique Id of the payment consent request
merchantTransactionId	string max 64 chars)	O	human-readable reference string from the merchant to identify a transaction
amount	decimal (max 2 digits)	M	payment amount, range 0.01 to 100000
currency	string (ISO4217)	M	Currency Code - only EUR
finalCapture	boolean	O	indicates if capture is the last capture (true/false) - default: false

Payment Refunds

Field	Format	CND	Description
paymentId	uuid	M	unique Id of the payment consent request
captureId	uuid	M	identifier of the capture to be refunded
amount	number	M	payment amount, range 0.01 - 100000
currency	string (ISO4217)	M	Currency Code - only EUR
refundReason	string	O	reason for refund (RETURNED_GOODS, WRONG_AMOUNT_CORRECTION, OTHER)
transactionDescription	string	O	a description text for a transaction, provided by the merchant

Subscriptions

ℹ️
Payment Plan Subscription: Sandbox integration already available
The new Subscription payment plan is already ready for integration and testing. Merchants can build, test and refine the subscription flows right now using the sandbox environment.
Please note: The official production release is scheduled for September 2026, meaning the payment plan will only become active and usable in the merchant production environment starting then.

Field	Format	CND	Description
repetition	string	M	defines chosen payment interval (WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY, YEARLY)
startAt	string (ISO8601)	M	specifies date from which the subscription contractually begins for the customer.
firstPaymentAt	string (ISO8601)	M	determines date of first payment for subscription
endAt	string (ISO8601)	O	specifies end date of subscription if known. Can be omitted, when not known.