VibeFox Pin Payments for OpenCart — Help

Requirements

OpenCart: 3.0.x (tested on 3.0.5.0) or 4.0.2 and later (tested on 4.1.0.3).

PHP: 8.0 or later.

Pin Payments account: a Pin Payments merchant account (for businesses in Australia or New Zealand; customers can pay from anywhere). You need its publishable key and secret key, for live and, for testing, for the test environment. No webhook secret is needed: the extension does not use webhooks. Card details are sent from the customer's browser straight to Pin Payments by Pin.js and never reach your store, so the store falls under PCI SAQ A-EP.

Currency: AUD, USD, NZD, SGD, EUR, GBP, CAD, HKD, JPY, MYR, THB, PHP, ZAR or IDR. The order is charged in its own currency.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

The download is one zip file with the packages for both OpenCart versions. Unpack it on your computer. It contains README.txt, the OpenCart 3 package wcp_pinpayments_gateway-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_pinpayments_gateway.ocmod.zip. Install only the package for your OpenCart version. The license key is the same for both versions.

OpenCart 3

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_pinpayments_gateway-oc3-(version).ocmod.zip. The extension has no OCMOD modifications, so Extensions > Modifications does not need a refresh. Instead of the installer you can copy the contents of the upload folder of this package into the root folder of your store.

2. Go to Extensions > Extensions and choose the type Payments. Find VibeFox Pin Payments Gateway and click Install (the green + button). Your admin user needs the right to modify the payment extensions list.

3. Click Edit (the pencil button) to open the settings page. Paste your VibeFox license key into License key in the license block at the top of the page and click Activate (see License key).

4. In the Pin Payments dashboard open Account > API Keys and copy your test keys into Test publishable key and Test secret key. Keep Test mode on, turn on Enable/Disable and click Save.

5. Place a test order with a Pin Payments test card. When everything works, enter the live keys, turn off Test mode and save.

OpenCart 4

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_pinpayments_gateway.ocmod.zip. Do not rename the file: OpenCart 4 takes the extension code from the file name, and a renamed package does not work.

2. The package appears in the list of installed extensions on the same page. Click Install (the green + button) next to it.

3. Go to Extensions > Extensions and choose the type Payments. Find VibeFox Pin Payments Gateway, click Install (the green + button), then Edit (the pencil button).

4. Enter the license key and the Pin Payments keys as in steps 3 to 5 for OpenCart 3. The settings page and its fields are the same in both versions.

A new install starts with the payment method turned off and test mode on.

Configuration

All settings are on the extension page: Extensions > Extensions > Payments > VibeFox Pin Payments Gateway > Edit. The sections are listed on the left; the Save button under the list saves the whole page. Above the settings the page shows Pin Payments is in TEST MODE: the test API and test keys are used, no real charges are made. while test mode is on, an error while the publishable key or the secret key of the current mode is empty (the payment method is then hidden at checkout), and an error when Pin Payments does not support the default currency of the store (with the list of supported currencies). Without the right to modify the extension the page shows the settings but cannot save them.

When you save, nothing is saved if a field is wrong: Title must not be empty (Enter a title for the payment method (at most 128 characters).), Sort Order must be a whole number (negative values are allowed), Total a number 0 or greater, and Geo Zone and the order statuses must exist.

Pin Payments

Enable/Disable: Enable Pin Payments turns the payment method on or off. Default: off.

Title: the payment method name customers see at checkout. It is also the payment method name stored in the order. Default: Credit card (Pin Payments). Required, at most 128 characters.

Description: the text shown to the customer at the Confirm Order step, above the card form. Default: Pay with your credit card via Pin Payments.

Sort Order: the position of Pin Payments among the payment methods at checkout. Leave it empty or enter a whole number.

Geo Zone: offer the card form only for payment addresses in the selected geo zone. Default: All zones. Geo zones are set up in System > Localisation > Geo Zones.

Total: the checkout total, in the default currency of the store, that an order must reach before the payment method is offered. Leave it empty to offer it for any total.

API keys

Find your keys in the Pin Payments dashboard (the page links to dashboard.pinpayments.com) under Account > API Keys. Test keys work only with the test API, live keys only with the live API. The publishable key is used by Pin.js in the customer's browser. The secret key never leaves your server.

Test mode: uses the Pin Payments test environment (test-api.pinpayments.com) and the test keys. No real charges are made, and customers see TEST MODE — no real charges will be made. above the card form. When it is off, the live API and the live keys are used. Refunds of an order always use the keys of the environment the order was paid in. Default: on.

Test publishable key: the publishable key of your Pin Payments test account.

Test secret key: the secret key of your Pin Payments test account.

Live publishable key: the publishable key of your live Pin Payments account.

Live secret key: the secret key of your live Pin Payments account.

Spaces around the keys are removed. Saved secret keys are never shown again. The field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it. To remove a saved secret key, tick Clear the saved value on save under the field and click Save.

Orders

OpenCart creates the order at the Confirm Order step without a status (a missing order). The order gets a status only after Pin Payments has answered the charge. Each field below lists your OpenCart order statuses.

Order Status After Payment: the card was charged for exactly the order amount and currency. Default: Processing.

On Hold (Review) Status: the charged amount or currency differs from the order, the charge is authorised but not captured, or Pin Payments gave no clear answer (timeout, server error), so a charge may exist. A note tells you what to check in the Pin Payments dashboard. Default: Pending, because OpenCart has no On hold status. You can create your own status in System > Localisation > Order Statuses and select it here.

Refunded Status: set after the payment is fully refunded from the order tab. Default: Refunded.

Advanced

Debug log: writes Pin Payments API calls to wc_ppg_debug.log.php in the OpenCart logs folder (storage/logs). The file cannot be opened from the web, and at 5 MB it is moved to wc_ppg_debug.old.log.php. Errors and warnings are always logged; turn this on to log every API call as well. Card data, API keys and customer personal data are never logged. Default: off.

Log: shows the size and the latest entries of the log. Click Clear log to empty it.

Delete data on uninstall: when on, uninstalling the extension removes the gateway settings and the log. The payment data of orders (charges and refunds) is always kept. Default: off.

Import / Export

Export: Download JSON saves the settings as a JSON file. Secret keys are not exported.

Import: paste previously exported JSON and click Import to restore the settings. Saved secret keys are kept.

Checkout

The payment method is shown when it is enabled, both keys of the current mode are set, the order currency is one of the 14 supported currencies, the payment address is in the selected Geo Zone and the order reaches the Total.

At the Payment Method step the customer chooses the payment method (by default Credit card (Pin Payments)). OpenCart creates the order at the Confirm Order step, still without a status. There the customer sees your description, the Visa, Mastercard and American Express icons and the card form: Card number, Expiry (MM / YY), CVC and Name on card. On OpenCart 4 the customer picks the payment method with the Choose button of the payment method block, in the window Payment method options; the card form then appears in the confirm block at the bottom of the checkout page, above the Confirm Order button. Before sending, the form checks the card number length, the expiry month and year, a CVC of 3 or 4 digits and the name.

When the customer clicks Confirm Order, Pin.js sends the card details and the payment address of the order (on OpenCart 4, when the checkout asks for no payment address, the shipping address) from the browser directly to Pin Payments and gets a single-use card token. Only this token is sent to your store. The extension then creates a captured charge for the order total in the order currency, with the customer's e-mail and IP address and the description <store name> - Order <order number>. Pin Payments answers in the same request.

After a successful charge the order gets its status the standard OpenCart way, with the usual order e-mails and stock update, the cart is emptied and the customer sees the OpenCart order success page with Your card payment has been received. If the order went to the review status, the page shows Your card payment has been received and is being reviewed. We will update your order as soon as the review is complete.

If Pin Payments does not answer (timeout, server error, unreadable answer), a charge may still have been created. The order is then put in the review status with a note, and the success page shows We could not confirm your payment with Pin Payments. Please check your e-mail and card statement before paying again, or contact us. Submitting the same cart again never creates a second charge.

Only one payment attempt per cart runs at a time. A second submit gets This order is already being paid. Please wait a moment and check your e-mail before trying again. OpenCart 3 creates a new order every time the Confirm Order step is shown, OpenCart 4 updates the order of the checkout (after a declined card the customer pays the same order), and a cart that is already paid by another order goes straight to the success page, and an earlier attempt that took or may have taken money gives its status to the order instead of a new charge. A card token can be used once: after a failed attempt, or when the customer changes the card details, a new token is created.

OpenCart 4 keeps the order in the checkout until the success page is shown. If that order already has a status when the customer confirms a new purchase (for example it was paid and the success page was never opened, or you cancelled it), the customer is taken back to the checkout, and the next Confirm Order pays a new order of the current cart. Above the checkout page the customer sees Your previous order was cancelled or refunded by the store. Please confirm the order again to pay with a new order. when the order was closed, or Your previous order #(number) has already been placed. Your cart has changed: please confirm the new order to pay for it. when it was placed for an earlier cart. A paid order is never shown as paid for a different cart.

When the payment fails, the order stays without a status. The customer stays at the Confirm Order step, the cart is kept and one of these messages is shown above the card form: Your card was declined. Please use another card or contact your bank.; Your card has insufficient funds. Please use another card.; Your card has expired. Please use another card.; The card security code (CVC) is incorrect.; This card type is not accepted. Please use Visa, Mastercard or American Express.; Payment failed: with Pin Payments' reason for rejected details; Your card details have expired. Please enter them again and retry. when the token cannot be used; The secure card form could not be loaded. Please reload the page or choose another payment method. when Pin.js does not load; Card payments are temporarily unavailable. Please try again later or choose another payment method. when Pin Payments rejects the secret key; Your payment could not be processed. Please try again or choose another payment method. for other errors. The technical reason is written to the log.

The extension has no 3-D Secure flow. If your Pin Payments account requires 3-D Secure, the charge stays pending, the order gets no status and the customer sees Your card payment could not be completed (additional verification is required). Please try another card or another payment method. There is no authorize-only mode with a later capture, no saved cards, no subscriptions, no Apple Pay or Google Pay and no webhooks.

Orders and refunds

Order statuses

No status (missing order): the card was declined, the charge needed 3-D Secure, or the customer has not paid. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders.

Order Status After Payment (default Processing): Pin Payments reported a successful, captured charge for exactly the order amount and currency. A note shows the amount and the charge token (and TEST MODE for test payments).

On Hold (Review) Status (default Pending): the charge needs your review. The note explains why: Pin Payments charged an amount or currency different from the order, the charge is authorised but not captured (capture it in the Pin Payments dashboard, then change the order status), or Pin Payments gave no clear answer (look for the charge description in the Pin Payments dashboard before the order ships).

Refunded Status (default Refunded): the charge was fully refunded through the extension.

If a second charge is made for a cart that is already paid, the paid order is not changed. A note asks you to check it and refund it in the Pin Payments dashboard.

Notes are entries in the order History that the customer does not see.

VibeFox Pin Payments Gateway tab

In Sales > Orders open an order paid with Pin Payments. At the bottom of the order page, next to History and Additional, the VibeFox Pin Payments Gateway tab shows the Charge token with a Test label for test payments, the Status, the Card brand and last four digits, the amounts Charged / order / refunded, the Charge description, the refund form, the refund history and the Pin Payments notes of the order. The tab is shown to users who have access to the extension.

Refunds

In the VibeFox Pin Payments Gateway tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via Pin Payments. Confirm the question Refund this amount through Pin Payments? This cannot be undone. Full and partial refunds are supported. You need the right to modify the extension (set in System > Users > User Groups). Refunds are limited to the amount and currency Pin Payments actually charged, so after an amount or currency mismatch you can refund up to what the customer paid, not the order total. The refund is sent to the environment (test or live) the order was paid in, so that mode's secret key must be set. Pin Payments processes refunds asynchronously, so the status is usually Pending. A successful request is added to the refund history and the notes with the Pin Payments refund token and its status. A full refund sets the order to Refunded Status without notifying the customer and without returning products to stock, like a manual status change. A partial refund does not change the status. If Pin Payments rejects the refund or does not answer, the tab shows the error and no refund is recorded.

When no charge is recorded for the order (Pin Payments gave no clear answer), the tab shows no refund form and tells you which description to look for in the Pin Payments dashboard.

Product returns in Sales > Returns do not send money back through Pin Payments. Refunds made in the Pin Payments dashboard are not synced back to OpenCart, so make them from the order page.

License key

The extension works with a VibeFox license key from vibefox.net. The license block License — VibeFox Pin Payments Gateway is the first block on Extensions > Extensions > Payments > VibeFox Pin Payments Gateway > Edit, above the settings. Paste the key into License key and click Activate. After that the block shows the key masked, the status (for example the date the license is active until and your domain) and the buttons Check now to check the status again, Change key to enter another key and Remove key to remove the key from this store. Below them are the line Product: opencart-payment-pinpayments and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only admin users with the Modify permission for the extension can change the key. The texts of the block follow the admin language (English and Russian are included).

If the key is not accepted, the block says why, for example Key not found, This key belongs to another product, Domain limit reached or License expired on a date. After the store address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the extension keeps working on the last known status.

One key works on one domain: the store address from the OpenCart configuration. Removing the key from the store does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Pin Payments is not shown to customers at checkout. If a payment is started anyway, the customer sees This payment method is not available. Please choose another one. An admin user who is logged in to the admin in the same browser still sees the payment method in the store, marked (unlicensed — visible to admins only), so you can set up and test the extension before you buy a key. On OpenCart 4 this preview is not available: the store does not see the admin login, so without an active key the payment method is hidden for everybody. After you have opened the Edit page once, a reminder appears on the admin Dashboard. Close it with × to hide it for 7 days. Existing orders are not affected: refunds of orders paid before still work.

When a license expires, the extension keeps working, but updates and support need a renewal. The status is checked again automatically when you open the admin Dashboard or the Edit page: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling the extension always removes the license key and license status.

Troubleshooting

Pin Payments does not appear at checkout: check that the license is active, Enable/Disable is on, both keys of the current mode are filled in (Test publishable key and Test secret key in test mode, the live keys otherwise) and the order currency is one of the 14 supported currencies. Also check that the payment address is in the selected Geo Zone and that the order reaches the Total set in the settings. The settings page shows an error for missing keys and for an unsupported store currency.

The payment went through, but the order is in the review status: read the notes in the VibeFox Pin Payments Gateway tab (see Order statuses). If Pin Payments gave no clear answer, look in the Pin Payments dashboard for a charge with the description <store name> - Order <order number>, then fulfil the order or refund the charge in the dashboard.

The customer sees Your payment was received, but the order could not be completed automatically: the card was charged, but the order status could not be set (for example, the order was deleted meanwhile). The reason is in the log. The customer is asked not to pay again; submitting the same cart again gives the order its status without a new charge.

The customer sees This payment method is not available. Please reload the checkout page.: the checkout session no longer matches the order, or the payment method was turned off meanwhile. The customer reloads the checkout.

Customers see Card payments are temporarily unavailable: Pin Payments rejected the secret key, or the key of the current mode is missing. Test keys work only in test mode, live keys only in live mode. The log shows the reason.

Orders fail with additional verification is required: your Pin Payments account requires 3-D Secure, which the extension does not support. Ask Pin Payments to turn off mandatory 3-D Secure.

The secure card form could not be loaded: Pin.js from the Pin Payments CDN did not load in the browser, for example because of a script blocker or an extension that combines or changes scripts. Exclude the checkout from such optimizations.

Pin Payments did not respond: the card token was not created within 30 seconds in the browser. The customer can check the connection and try again; nothing was charged.

Payment failed with a Pin Payments reason: Pin Payments rejected the charge details, for example an amount below its minimum charge for the currency. The customer sees the reason, and the log has the error code.

Refund fails: read the message in the tab. A message about TEST or LIVE mode means the secret key of the mode the order was paid in is empty. Pin Payments did not confirm the refund means no answer came; check the charge in the Pin Payments dashboard before trying again. at most shows the amount still refundable from the charge.

Test payments: test mode uses the test environment and test keys. Use the test cards from the Pin Payments developer documentation, for example 4200 0000 0000 0000 (succeeds), with any future expiry date and any CVC. Orders keep the mode they were paid in, so refunds go to the right environment after you switch modes.

Where to find errors: errors are always written to the log; see the Log field on the extension page. Turn on Debug log to see every API call.

Uninstall

Go to Extensions > Extensions, choose the type Payments and click Uninstall (the red − button) next to VibeFox Pin Payments Gateway. The license key and license status of this extension are always removed. OpenCart always removes its own settings of the extension: Enable/Disable, Sort Order, Geo Zone, Total and the order statuses of the Orders section, which return to their defaults on a re-install. The OpenCart event of the extension is removed too (on OpenCart 4 its two events, which show the messages on the success page and above the checkout page). If Delete data on uninstall is on, the other gateway settings (title, description, test mode, keys, debug log switch) and the log are removed. If it is off, they are kept for a later re-install. The Pin Payments charges and refunds are always kept, so orders paid before can still be refunded after a re-install. Existing orders keep their payment notes.

On OpenCart 4, to remove the files of the extension as well, go to Extensions > Installer after the uninstall and click Uninstall (the orange − button) next to VibeFox Pin Payments Gateway in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

Pin Payments is a trademark of its respective owner. This extension is not affiliated with or endorsed by Pin Payments.