>plugins>magento
Magento Checkout Module
The Snap Checkout App is ideal to capture customers at the tail end of their shopping journey when they are ready to check out. Your customers can easily apply, and if approved, directly check out on your website using Snap to pay. It supports Cancel, Capture and Refund orders.
Setup
Installation
Install the module from the Adobe Commerce Marketplace, configure it and test it.
Step 01 Visit Magento Marketplace
Go to your Magento Admin Panel and click on "Find Partners & Extensions" in the left sidebar.
Once you are in that page, click on "Visit Magento Marketplace" to be redirected to the Magento Marketplace.
Step 02 Module Checkout
Search for "Snap Finance UK" in the search bar and click on the first result.
Be sure that your "Edition" and "Store Version" are the correct ones.
⚠️ Important: Check out the extension using the same Adobe Commerce Marketplace credentials as your Magento store. Using a different account will cause installation to fail.
Click on "Add to Cart" and then "Proceed to Checkout".
Once you've done that, select "Place Order".
Step 03 Installation
Once you have checked out and placed the order, you can go ahead and install the module.
To install it you must use the command line. You can do this by using SSH or by using the command line on your local machine.
Once you are in the command line, navigate to the root of your Magento installation and run the following command:
🆘 What to do if your installation fails: Locate your
auth.json file, and check that the Adobe Credentials listed are the same as the ones you used at the checkout. The auth.json file is typically located at /src/var/composer_home.You can see your Adobe credentials here.
composer require snap-finance-uk/payment:1.0.9Step 04 Flush Cache
Once the app has been installed, you will need to refresh cache and re-compile the Magento application.
You can do this by running the following command in the command line:
php bin/magento setup:upgrade && php bin/magento setup:di:compile && php bin/magento setup:static-content:deploy -f && php bin/magento indexer:reindex && php bin/magento cache:cleanStep 05 Verify Plugin Installation
Once the app has been installed, you can navigate back to your Magento Admin Panel.
In the sidebar, click on "Stores" and then "Configuration".
In the left sidebar, click on "Sales" and then "Payment Methods".
You will need to scroll down to the end of the page. You should then see "Snap Finance UK" under the "Other Payment Methods" section.
Step 06 Configuration
Once you have found the "Snap Finance UK" section, you will need to add your Snap credentials.
The Merchant ID, Client ID and Client Secret Key for both sandbox and production will be provided by Snap Finance UK as part of the retailer onboarding process.
Please ensure that the plugin is Enabled and that the "Mode" is set to "Sandbox" to test it before going live.
Once you have filled in these fields, you can click on the "Save Config" button in the top right corner.
📝 Note: The Minimum and Maximum Order Total and Sort Order Fields are not active at the moment. We are actively working on it and will be available soon.
Step 07 Testing
The installation has been completed! 🎉
To verify and view the customer experience, initiate the checkout application flow. A new "Snap Finance" payment method will be displayed.
To run test applications, force a decision and use test payment details, follow the sandbox testing guide for Magento.
Step 08 Verification
After your customer completes the checkout process, the order will be available in your Magento Admin Panel.
You will be able to see the completed order on the "Last orders" section.
If you click on the order to view its details, under the "Payment Information" section, you will be able to see that "Snap Finance UK Checkout" was the payment method used.
Guide
Order Management
After checkout, use the guides below to understand when Magento orders are created, how Snap statuses relate to Magento, and what to expect for fulfilment and refunds.
When the order is created in Magento
The Magento order is created at the end of checkout, once the customer has finished the Snap Finance application and Snap reports PENDING_DEL (26) or COMPLETE (30). Until then, no order exists in Magento — the customer is only in the Snap application flow.
When the order is first created, Magento sets the initial status according to your store configuration — typically Processing, meaning the order is confirmed and awaiting fulfilment. Set the order to Complete in Admin after delivery to notify Snap.
Order status mapping (Snap → Magento)
Snap uses
progressStatus codes to track each finance application. Magento orders are only created when Snap reports PENDING_DEL (26) or COMPLETE (30).The table below lists every Snap status, its equivalent Magento status, and when it applies in the checkout and order lifecycle.
| Snap code | Snap status | Description | Equivalent Magento status | When updated |
|---|---|---|---|---|
| 2 | PENDING | Application started | Pending | During checkout — Magento order not created yet. |
| 6 | APPROVED | Approved | Pending | During checkout — not yet ready for order placement. |
| 10 | APPROVED_WITH_COND | Approved with conditions | Pending | During checkout — conditions must be met before placement. |
| 14 | DENIED | Denied | Canceled | Checkout blocked — application was declined. |
| 18 | WITHDRAWN | Withdrawn | Canceled | Checkout blocked — customer withdrew the application. |
| 22 | PENDING_DOCS | Pending documents | Pending | During checkout — awaiting documents from the customer. |
| 26 | PENDING_DEL | Pending delivery | Processing | Magento order created at checkout. Awaiting fulfilment/delivery. |
| 30 | COMPLETE | Complete | Complete | Magento order created at checkout. Snap application is fully complete. |
| 0 | FUNDED | Funded | Processing | During checkout — order placement not yet allowed. |
| -1 | ERROR | Error | Canceled | Checkout blocked — an error occurred on the Snap application. |
Order comments — fulfilment and refunds
Magento records order comments in the order history (Comments History on the order view page). The Snap plugin adds comments only at order placement; fulfilment and refund activity is logged separately.
When the Snap order is placed
Immediately after a successful Snap checkout and Magento order creation, the plugin adds a comment such as The authorized amount is £X.XX. (formatted order grand total).
The Application ID is stored on the payment record and in the payment transaction.
What is not added to order comments
The following events are not written to Magento order history by the plugin: Snap progressStatus changes, fulfilment (
completePendingDelivery), and refund success or failure (refundCancelAccount).These events are recorded in the plugin log file (
snap_payment logger) instead.On fulfilment — when the order state is Complete
Set the Magento order state to Complete in Admin after delivery. The plugin notifies Snap when Snap status is PENDING_DEL (26) only — if Snap is already COMPLETE (30), the fulfilment API is not called.
| Where to check | What it means |
|---|---|
Plugin log — completePendingDelivery: {id} | message: ... | Delivery date was sent to Snap successfully. |
Plugin log — completePendingDelivery error - Application Id: ... | Fulfilment API call failed. |
| No log entry after saving Complete order | Conditions not met — check payment method, Application ID, order state, or Snap status. |
On refund — when a credit memo is created
Create a credit memo and refund as usual (Sales → Orders → [order] → Credit Memo → Refund). The refund is only saved if the Snap API call succeeds. Refunds are allowed when Snap status is PENDING_DEL (26) or COMPLETE (30).
On failure, an error message is shown in Admin — it is not saved to order history.
| Admin error message | Meaning |
|---|---|
Snap application ID is missing on this order. Refund was not sent to Snap. | No Application ID on the payment record — refund blocked. |
Could not verify Snap application status. ... | Status API failed — refund was blocked before reaching Snap. |
Snap refund is only allowed when application status is Pending Delivery (26) or Complete (30). Current status: ... | Application is not in a refundable state. |
Snap refund failed (HTTP XXX). ... | Snap API rejected the refund request. |
Snap refund request failed: ... | Network or other error — refund was not sent to Snap. |
Checkout errors (customer-facing, not order comments)
| Message | When |
|---|---|
Snap application could not be validated for checkout placement. | Snap status is not PENDING_DEL (26) or COMPLETE (30) when placing the order. |
Snap application is not bound to this checkout session. | Application ID does not match the active checkout session. |
Order total changed after Snap application was started. Please restart checkout. | Cart total changed after the Snap application was started. |
This Snap application has already been used for another order. | Application ID was already used for a previous order. |
Where to find Snap information on an order
The Snap Application ID is shown in the Snap Application section on the Admin order view page (
Sales → Orders → [order]).Order comments appear in Comments History on the same page. Plugin logs are in
var/log/ (snap_payment logger).Customise
Product Widget
The Snap Finance UK module can display finance widgets on Magento product pages. Configure them under Stores → Configuration → Sales → Payment Methods → Snap Finance UK — no custom theme code is required for most stores.
Step 01 Open plugin settings
In the Magento Admin Panel, go to "Stores → Configuration".
In the left sidebar, open "Sales → Payment Methods", then scroll to "Snap Finance UK".
Step 02 Enable PDP widgets
Set "Enable PDP widgets" to Yes to load Snap widgets on Magento product pages.
If this option is set to No, no product widgets will display, even if the individual widget types below are enabled.
Ensure the Snap Finance UK payment method is also Enabled above.
Step 03 Choose widget types
Select one or more widget types to show near the product price:
Standard product widget — shows the standard Snap finance message (no theme option).
RBP widget — shows the representative example (RBP) widget. When enabled, choose an RBP theme of Dark or Light.
BNPL widget — shows the Buy Now Pay Later widget. When enabled, choose a BNPL theme of Dark or Light.
Step 04 Optional theme and mount settings
PDP script mode (Hyvä vs Luma) — leave as Auto unless your store uses a custom theme. Choose Hyvä or Luma explicitly if widgets do not load.
Widget mount CSS selector — optional. Leave empty for auto-detect, or enter a CSS/jQuery selector (for example
.product-info-price) if widgets do not appear on your theme.Step 05 Save and verify
Click "Save Config" in the top right of the configuration page.
If needed, flush Magento cache so the storefront picks up the new settings.
Open any Magento product page on the storefront. The selected Snap widgets should appear near the product price.
For more detail on widget behaviour and theming, see the SDK Widgets documentation.
Widget on the product page
Once enabled, the selected widgets appear on the Magento product page near the price, as shown on the right.
Help
Additional Information
The Merchant Portal and where to get help.
The Snap Merchant Portal
The Snap Merchant Portal is where you view and manage all of your Snap Finance applications and orders. It is the ultimate source of truth for the status of every application.
Access details for the Merchant Portal will be provided during your onboarding and training. If you need access, or have lost your login details, contact your Snap Finance account manager.
Need help?
For any queries please contact your Snap Finance account manager.