Skip to content

Admin Handling

lat9 edited this page Jan 12, 2024 · 8 revisions

When an order is placed using the paypalr payment module, there will be a "Click for Additional Payment Handling Options" link available when viewing the order's details in your Zen Cart admin console. Click on that link to view additional information about the payment and perform after-order operations (void, capture, refund and re-authorize) on that order. The information shown immediately after the order is placed is slightly different, depending on your choice of the Payment Action when you configured the payment module.

If you chose Auth Only, the payment has been authorized but you do not yet have those funds in your PayPal account. The information displayed for the order looks similar to: image

When you choose Final Sale, the payment has been captured and those funds are in your PayPal account. The information displayed for the order looks similar to: image

View Transaction Details

Click the Details button associated with the order's primary transaction to view some additional details regarding the information sent to and returned from PayPal. A modal pop-up is displayed:

image

Re-Authorize a Transaction

When an order's payment is initially authorized, you might want to re-authorize that transaction. A couple of scenarios come to mind:

  1. You are about to capture the funds for the transaction and want to ensure that the customer's funds are still available.
  2. You don't know the actual shipping cost for the order when the order is placed. You can re-authorize the transaction for up to 115% of the order's original value (not to exceed $75 USD). This increased authorization is allowed one time during the transaction's 30-day settlement period.

Regardless the reason that you want to re-authorize the transaction, PayPal imposes an honor period of three days between authorizations. If you attempt to re-authorize a transaction during this honor period, the associated modal pop-up will let you know and prohibit the PayPal action:

image

Otherwise, the pop-up's initial display contains an input field where you can enter the amount to re-authorize. Click the Re-Authorize button to cause the Confirm button to show, then click the Confirm button to confirm the action. You can press the Close button at any time to cancel the operation.

Initial Display After Clicking Re-Authorize
image image

Void an Authorization

There are a couple of scenarios in which you might want to void an authorized transaction:

  1. The ordered product is discontinued, so the order cannot be fulfilled.
  2. The customer ordered two products. One is discontinued, but the customer agrees to receive the other product. In this case, you have captured the funds required to deliver that product to the customer and want to remove the 'hold' on the remainder of the funds that is currently present on the customer's account.

Note that a void is irreversible; once an authorization is voided, no additional funds can be captured for the transaction! You do have the capability to refund all or part of any funds previously captured. When you click the Void button associated with the order's authorization, an initial pop-up is displayed in which you can copy and paste (as confirmation) the authorization's transaction ID and enter any message to the customer. Click the Void button to cause the Confirm button to be displayed, then click the Confirm button to confirm the action. You can click the Close button at any time to cancel the action.

Initial Display After Clicking Void
image image

Capture an Authorized Payment

When an order's payment is initially authorized, you will eventually want to capture the funds for that transaction! You can perform multiple captures on an authorized transaction, up to the amount currently authorized.

If you have already captured the full amount authorized or indicated that a previous capture is the final one, the pop-up lets you know that no further captures are available:

image

Otherwise, the pop-up's initial display contains a form that allows you to:

  1. Enter the amount to be captured. The value entered is limited to the Remaining to Capture amount!
  2. Optionally, indicate that all the remaining funds are to be captured; just tick the associated checkbox.
  3. Enter a note to the customer. The note will be included in any email sent by PayPal and will be recorded as part of the order's status-history if you confirm the capture.
  4. Optionally, indicate that this is a final capture — i.e. you will not be performing additional captures for the associated authorization.

Click the Capture button to cause the Confirm button to show, then click the Confirm button to confirm the action. You can press the Close button at any time to cancel the operation.

Initial Display After Clicking Capture
image image

Refunding Captured Funds

When all or part of an order's authorized funds have been captured, there are circumstances when a refund is in order. Funds have been captured if you've configured paypalr to perform a Final Sale on order completion or if the module's configuration is Auth Only and you've captured funds after order placement. Each individual capture is separately refunded; here's an example screenshot of an order that was

  1. Originally authorized for $59.99.
  2. Re-authorized for $68.98 (the maximum amount).
  3. Partially captured $28.98
  4. Remaining captured $40.00 (now the full amount).

Note how each separate capture has its own Refund.

image

The Refund pop-up's initial display contains a form that allows you to:

  1. Enter the amount to be refunded. The value entered is limited to the Remaining to Refund amount!
  2. Optionally, indicate that all the remaining funds are to be refunded; just tick the associated checkbox.
  3. Enter a note to the customer. The note will be included in any email sent by PayPal and will be recorded as part of the order's status-history if you confirm the refund.

Click the Refund button to cause the Confirm button to show, then click the Confirm button to confirm the action. You can press the Close button at any time to cancel the operation.

Initial Display After Clicking Refund
image image
Clone this wiki locally