Pay widget

General Information

The Pleenk Pay widget can be included anywhere to receive payments. This widget is either an iframe or a link pointing to the Pleenk app.

Properties

ParameterTypeDescriptionOptional
pw_confidentiality_walletUUIDConfidentiality wallet ID where the widget is loadedYes
pw_descriptionStringFree label for the operationYes
pw_funds_blocking_periodString (formatted as jsr310-period)Escrow durationYes
pw_manual_confirmString (formatted as jsr310-period)Timeout for confirmation durationYes
pw_transaction_refStringPayment Reference/ID internal of the marketplace. Must be unique per privacy scope to avoid double transactions.No
pw_metadataStringRaw metadata forwarded with notification callbacksYes
pw_beneficiary_0String|BigDecimalFirst beneficiary information of the transaction formatted as "PleenkEntityRef|AMOUNT". Amount uses "." as the decimal separator with no limits on decimals.No
pw_callbackURLReturn URL after operation (pay)Yes
pw_requestPleenkApproveRequestPleenk Approve requestYes
signatureStringWidget signature to ensure that the provided information is certified by the marketplace.No

Notifications

  • Type: PAYMENT
  • Data:
    • transactionRef (String): pw_transaction_ref from the request.
    • paymentId (String): Unique internal ID for the payment.
    • metadata (String): pw_metadata from the request.
    • status (Enum): {CONFIRMED}.