+ {% elseif invoice.is_payment_submitted %}
+
-
subtotal ?: 0) ?>
+
formatCurrency($formModel->subtotal ?: 0) ?: Currency::format($formModel->subtotal ?: 0) ?>
- : discount ?: 0) ?>
+ : formatCurrency($formModel->discount ?: 0) ?: Currency::format($formModel->discount ?: 0) ?>
-
total) ?>
+
formatCurrency($formModel->total) ?: Currency::format($formModel->total) ?>
- : tax) ?>
+ : formatCurrency($formModel->tax) ?: Currency::format($formModel->tax) ?>
diff --git a/controllers/invoices/_scoreboard_preview.php b/controllers/invoices/_scoreboard_preview.php
index 4712a1d..ec2e724 100644
--- a/controllers/invoices/_scoreboard_preview.php
+++ b/controllers/invoices/_scoreboard_preview.php
@@ -29,8 +29,8 @@
-
currency?->formatCurrency($formModel->total) ?: Currency::format($formModel->total) ?>
+
getCurrencyObject()?->formatCurrency($formModel->total) ?: Currency::format($formModel->total) ?>
- : currency?->formatCurrency($formModel->tax) ?: Currency::format($formModel->tax) ?>
+ : getCurrencyObject()?->formatCurrency($formModel->tax) ?: Currency::format($formModel->tax) ?>
diff --git a/docs/building-payment-types.md b/docs/building-payment-types.md
index 56671dd..8c0d5d8 100644
--- a/docs/building-payment-types.md
+++ b/docs/building-payment-types.md
@@ -137,6 +137,42 @@ Using the redirection method, when the user clicks the Pay button, they are redi
### Client-side Method
-Using the client-side method, the payment form is handled using custom JavaScript. When the user clicks Pay, the request is submitted back to the server using a locally registered API endpoint, which communicates to the payment gateway via a REST API or equivalent. The response given with JSON And is processed by the JavaScript code. If everything is successful the `onPay` AJAX handler is called to redirect to the confirmation page.
+Using the client-side method, the payment form is handled using custom JavaScript. When the user clicks Pay, the request is submitted back to the server using a locally registered API endpoint, which communicates to the payment gateway via a REST API or equivalent. The response given with JSON and is processed by the JavaScript code. If everything is successful the `onPay` AJAX handler is called to redirect to the confirmation page.
-> **Note**: View the `Responsiv\Pay\PaymentTypes\PayPalPayment` class for an example of a redirection payment type.
+> **Note**: View the `Responsiv\Pay\PaymentTypes\PayPalPayment` class for an example of a client-side payment type.
+
+## Handling Pending Payments
+
+Some payment gateways don't confirm transactions immediately. For example, PayPal may return a `PENDING` capture status when the seller's account requires manual review. In these cases, you should update the invoice status to `approved` to indicate the customer has submitted payment, while waiting for final confirmation via a webhook.
+
+```php
+use Responsiv\Pay\Models\InvoiceStatus;
+
+if ($captureStatus === 'COMPLETED') {
+ $invoice->markAsPaymentProcessed();
+}
+elseif ($captureStatus === 'PENDING') {
+ $invoice->updateInvoiceStatus(InvoiceStatus::STATUS_APPROVED);
+}
+```
+
+When the invoice status is `approved`, the payment page will display a "payment is being processed" message instead of showing payment methods again, preventing the customer from paying twice.
+
+## Checking Payment Status
+
+Gateways can implement the `checkPaymentStatus` method to poll the payment provider when the customer revisits the payment page. This allows pending payments to be confirmed without waiting for a webhook. The method is called automatically by the `Payment` component when an invoice has been submitted but not yet confirmed.
+
+```php
+public function checkPaymentStatus($invoice): bool
+{
+ // Query your payment gateway API to check the current status
+ // If the payment is now confirmed:
+ $invoice->markAsPaymentProcessed();
+ return true;
+
+ // If still pending or unable to check:
+ return false;
+}
+```
+
+The method should return `true` if the payment was confirmed, or `false` otherwise. Any exceptions thrown will be caught silently by the component, so the payment page will still render normally if the check fails.
diff --git a/formwidgets/Discount.php b/formwidgets/Discount.php
deleted file mode 100644
index d7f1202..0000000
--- a/formwidgets/Discount.php
+++ /dev/null
@@ -1,151 +0,0 @@
-fillFromConfig([
- 'fixedPrice'
- ]);
- }
-
- /**
- * {@inheritDoc}
- */
- public function render()
- {
- $this->prepareVars();
-
- return $this->makePartial('discount');
- }
-
- /**
- * Prepares the list data
- */
- public function prepareVars()
- {
- [$amount, $symbol] = $this->getLoadAmount();
- $this->vars['amount'] = $amount;
- $this->vars['symbol'] = $symbol;
-
- $this->vars['name'] = $this->formField->getName();
- $this->vars['field'] = $this->formField;
- $this->vars['fixedPrice'] = $this->fixedPrice;
- }
-
- /**
- * getLoadAmount
- */
- public function getLoadAmount()
- {
- $value = $this->getLoadValue();
- if ($value === null) {
- return [null, null];
- }
-
- $amount = $value;
-
- // Percentage
- $isPercentage = strpos($value, '%') !== false;
- if ($isPercentage) {
- $amount = str_replace('%', '', $amount);
- return [$amount.'%', '%'];
- }
-
- // Fixed price or discount
- $symbol = '';
- $isNegativeFloat = strpos($amount, '-') !== false;
- if ($isNegativeFloat) {
- $symbol = '-';
- $amount = str_replace('-', '', $amount);
- }
-
- $currencyObj = $this->getLoadCurrency();
- $amount = $currencyObj->fromBaseValue((int) $amount);
-
- return [$symbol.$amount, $symbol];
- }
-
- /**
- * {@inheritDoc}
- */
- public function getSaveValue($value)
- {
- if ($this->formField->disabled || $this->formField->hidden) {
- return FormField::NO_SAVE_DATA;
- }
-
- if (!is_array($value) || !array_key_exists('amount', $value)) {
- return FormField::NO_SAVE_DATA;
- }
-
- $amount = $value['amount'];
- $symbol = trim($value['symbol'] ?? '');
-
- if (!strlen($amount)) {
- return null;
- }
-
- // Percentage
- if ($symbol === '%' || str_ends_with($amount, '%') !== false) {
- $amount = str_replace('%', '', $amount);
- return "{$amount}%";
- }
-
- // Subtract
- if ($symbol === '-' || str_starts_with($amount, '-') !== false) {
- $amount = str_replace('-', '', $amount);
- }
-
- $currencyObj = $this->getLoadCurrency();
- $amount = floatval(str_replace($currencyObj->decimal_point, '.', $amount));
- $amount = $currencyObj->toBaseValue((float) $amount);
- return $symbol . $amount;
- }
-
- /**
- * getLoadCurrency returns the currency object to used. If the model uses multisite,
- * then extract the primary currency from the site definition, otherwise use the
- * primary currency definition.
- */
- public function getLoadCurrency()
- {
- if (
- $this->model &&
- $this->model->isClassInstanceOf(\October\Contracts\Database\MultisiteInterface::class) &&
- $this->model->isMultisiteEnabled()
- ) {
- return Currency::getPrimary();
- }
-
- return Currency::getDefault();
- }
-}
diff --git a/formwidgets/discount/partials/_discount.php b/formwidgets/discount/partials/_discount.php
deleted file mode 100644
index bc4ca35..0000000
--- a/formwidgets/discount/partials/_discount.php
+++ /dev/null
@@ -1,28 +0,0 @@
-previewMode): ?>
-
- - Log in to your PayPal Developer account
+ - Log in to your PayPal Developer account
- Click the My Apps & Credentials link in the menu
- Toggle the Live / Sandbox option depending on your requirements
- Click Create App and fill in the required details
@@ -13,5 +13,25 @@
- Copy the Client ID and paste it in the Configuration tab
- Copy the Secret Key and paste it in the Configuration tab
+
+
Setting up Webhooks (Optional)
+
+ Webhooks allow PayPal to notify your site when payments are completed, refunded or denied. This is recommended for production use.
+
+
+ - In your PayPal Developer Dashboard, navigate to your app and click Webhooks
+ - Click Add Webhook
+ -
+ Enter your webhook URL:
+
getWebhookUrl()) ?>
+
+ -
+ Subscribe to the following events:
+ PAYMENT.CAPTURE.COMPLETED,
+ PAYMENT.CAPTURE.REFUNDED,
+ PAYMENT.CAPTURE.DENIED
+
+ - Save, then copy the generated Webhook ID and paste it in the Configuration tab
+
diff --git a/paymenttypes/paypalpayment/fields.yaml b/paymenttypes/paypalpayment/fields.yaml
index 346d5eb..1e84d47 100644
--- a/paymenttypes/paypalpayment/fields.yaml
+++ b/paymenttypes/paypalpayment/fields.yaml
@@ -24,3 +24,8 @@ fields:
comment: PayPal client secret to authenticate with the client ID. Keep this secret safe.
tab: Configuration
type: sensitive
+
+ webhook_id:
+ label: Webhook ID
+ comment: Optional. Enter the Webhook ID from PayPal to enable automatic payment confirmation for pending transactions.
+ tab: Configuration
diff --git a/phpunit.xml b/phpunit.xml
new file mode 100644
index 0000000..0e72cb8
--- /dev/null
+++ b/phpunit.xml
@@ -0,0 +1,31 @@
+
+