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
| Parameter | Type | Description | Optional |
|---|---|---|---|
pw_confidentiality_wallet | UUID | Confidentiality wallet ID where the widget is loaded | Yes |
pw_description | String | Free label for the operation | Yes |
pw_funds_blocking_period | String (formatted as jsr310-period) | Escrow duration | Yes |
pw_manual_confirm | String (formatted as jsr310-period) | Timeout for confirmation duration | Yes |
pw_transaction_ref | String | Payment Reference/ID internal of the marketplace. Must be unique per privacy scope to avoid double transactions. | No |
pw_subscription_period | String (formatted as jsr310-period) | Define the interval for recurring payments using the JSR-310 period format (e.g., P1M for monthly or P1Y for yearly). | Yes |
pw_metadata | String | Raw metadata forwarded with notification callbacks | Yes |
pw_beneficiary_0 | String|BigDecimal | First beneficiary information of the transaction formatted as "PleenkEntityRef|AMOUNT". Amount uses "." as the decimal separator with no limits on decimals. | No |
pw_request | PleenkApproveRequest | Pleenk Approve request | Yes |
pw_callback | URL | Return URL after success operation (pay) | Yes |
pw_error_callback | URL | Return URL after failure operation (pay) | |
pw_notification | URL | URL to receive payment event notifications via webhook. A POST request with payment data in JSON will be sent to this endpoint. | Yes |
signature | String | Widget signature to ensure that the provided information is certified by the marketplace. |
Examples
- Simple payment:
https://app.pleenk.com/payment?pw_confidentiality_wallet=af9e3349-8031-4993-b649-ebd88109893d&pw_description=A-simple-payment&pw_transaction_ref=ORDER-123&pw_beneficiary_0=af9e3349-8031-4993-b649-ebd88109893d|10&signature=MGQCMEa8GaEVX6u7a2orsGVAreNAMDqptNiOtFGP2v_Rn4l25bUAVy74m66V9OYEuVNscwIwdCyk3TeQJp_bD5_5EfR_J4f0v94nE9Y155PGFcChr_KksRaQmUhRrx0XCeK8A37N
- Third-Party seller payment:
https://app.pleenk.com/payment?pw_confidentiality_wallet=af9e3349-8031-4993-b649-ebd88109893d&pw_description=A-simple-payment&pw_transaction_ref=ORDER-123&pw_marketplace_fee=2&pw_beneficiary_0=af9e3349-8031-4993-b649-ebd88109893d|2&pw_beneficiary_1=SELLER_341|10&signature=MGQCMEa8GaEVX6u7a2orsGVAreNAMDqptNiOtFGP2v_Rn4l25bUAVy74m66V9OYEuVNscwIwdCyk3TeQJp_bD5_5EfR_J4f0v94nE9Y155PGFcChr_KksRaQmUhRrx0XCeK8A37N
Notifications
- Type:
PAYMENT - Data:
transactionRef(String):pw_transaction_reffrom the request.paymentId(String): Unique internal ID for the payment.metadata(String):pw_metadatafrom the request.status(Enum): {CONFIRMED}.
Updated 15 days ago