Welcome to the official documentation for Veem Payments, the seamless payment gateway integration for WooCommerce. Veem Payments allows businesses to easily pay and get paid while offering a global payment solution. This documentation is designed to assist you in setting up, configuring, and making the most of this extension.
1. Introduction
↑ Back to topPurpose
↑ Back to topVeem Payments makes it incredibly easy for businesses to pay and get paid. It integrates seamlessly with WooCommerce and serves as a payment gateway while offering a straightforward solution for global payments.
Target Audience
↑ Back to topB2B (Business-to-Business)Veem Inc. stands out as the leading B2B payment solution, offering unparalleled benefits for both receivables and payables. With its emphasis on high-value transactions without limits, flexible payment options, and comprehensive tracking, Veem streamlines B2B operations, ensuring secure, efficient, and cost-effective transactions. Additionally, Veem’s robust security measures and commitment to industry standards solidify our position as a reputable partner for businesses looking to optimize their B2B financial processes.
2. System Requirements and Installation
↑ Back to topSystem RequirementsWordPress 5.7+.PHP 7.4+.WooCommerce installed.
Installation
↑ Back to topTo install the Veem Payments plugin, follow these steps:
- Download the Plugin here.
- Install the plugin on your WordPress following these instructions.
- Access WooCommerce, navigate to Payments, and locate the Veem Payments section.
3. Configuration
↑ Back to topAfter installation, configure Veem Payments by following these steps:
- Sign up for a Veem account here.
- In your Veem account, go to Settings > Integrations > VeemAPI and copy the Client ID and Client Secret.
- Return to your WooCommerce settings page and update the Client ID and Client Secret with the copied values.
- In order to get status updates for payments, you will need to contact Veem support (clientsupport@veem.com) with your webhook URL and we will enable that URL to receive payment status updates.
4. Features
↑ Back to top- Seamless integration of Veem Payments into your WooCommerce store
- Securely accept international payments from customers around the world
- Streamlined checkout process for customers
- Reliable and efficient payment processing
- Make payments to suppliers, facilitating transactions of any size
5. Usage
↑ Back to topCheckout Workflow with Veem Payments
↑ Back to top
- After setting up the Veem Payments extension, your clients can check out their products using Veem as the payment gateway.
- A popup opens, where clients provide their email and password (for account holders) or create a guest account.
- The popup captures essential information from the WooCommerce checkout, such as currency and amount.
- Customers choose a payment method and enter their information.
- Customers complete the payment and land on your order page.
- Veem triggers payment processing and updates order status via web-hooks.
Payable Workflow with Veem Payments
↑ Back to topVeem Payments offers a comprehensive suite of solutions for receivables and payables management. Merchants utilizing WooCommerce can easily access the Veem platform from their WooCommerce dashboard to pay suppliers or contractors quickly and securely.
Veem offers a wide range of payable features, including flexible payment options, enabling users to send funds globally through bank transfers, debit or credit cards. Notably, the Veem Wallet provides the added benefit of fee-free global USD transactions upon registration. Detailed payment tracking with timestamps ensures transparency, while the option for recurring payments streamlines regular transactions.
Veem’s automation capabilities extend to approval workflows and bill reconciliation, simplifying complex processes and enhancing overall efficiency. Moreover, by integrating Veem into their existing systems, businesses can seamlessly manage payables and receivables, centralizing operations and optimizing cash flow management.
6. Sandbox vs Production
↑ Back to topIn Veem Payments, the terms “Sandbox” and “Production” refer to distinct environments serving different purposes. The Sandbox environment is a testing environment where developers can experiment and test their code or applications without the risk of impacting live transactions. It allows developers to simulate various scenarios and ensure that their integration with Veem Payments functions smoothly before deploying it in the live environment. On the other hand, the Production environment is the live or real-time environment where actual transactions occur. It is the operational environment where businesses execute genuine payment transactions, and all actions taken here have real financial implications. Thus, the key disparity between Sandbox and Production in Veem Payments lies in their respective functions: Sandbox is for development and testing, while Production is for live transactions and operations.
7. Integration
↑ Back to topIn order to connect Veem’s webhook to your store and get notified on any payment status changes, you need to follow the steps below:
To get started with our Webhook System, register as a developer in our Sandbox environment. This will enable you to generate API keys, save your webhook and make test transactions without moving real money. You can use one of our SDKs to expedite the integration effort or write your own implementation.Once your code is tested and you’re ready to migrate to production, send us an email to ‘devsupport@veem.com’ and we will help you complete your setup.
8. Technical Extensibility
↑ Back to topThese code snippets enable businesses to customize the Veem WooCommerce extension for a more tailored and user-friendly experience. They facilitate the addition of custom payment fields, the modification of the checkout button’s appearance, and the seamless handling of postMessages during the payment process.
- Custom Payment Fields Addition: The code demonstrates how to add custom fields to the Veem payment options during checkout. By utilizing the ‘veem_additional_fields’ action hook, businesses can include additional fields tailored to their specific requirements, enhancing the flexibility and customization of the payment process.
// Function to add custom fields to the payment optionsfunction veem_custom_payment_fields($veem_instance) { // Add your custom fields here // Example: $veem_instance->add_field(‘custom_field’, ‘Custom Field’, true);}add_action(‘veem_additional_fields’, ‘veem_custom_payment_fields’);
- Checkout Button Customization: This code snippet showcases how to modify the appearance and functionality of the Veem checkout button. By leveraging the ‘woocommerce_order_button_html’ filter, businesses can tailor the checkout button’s HTML to align with their brand aesthetics and improve the overall user experience during the checkout process.
// Function to customize the Veem checkout buttonfunction customize_veem_checkout_button_html($button_html) { // Modify the button HTML as per your requirements // Example: $button_html = ‘<a href=”#” class=”custom-button-class”>Custom Checkout</a>’; return $button_html;}add_filter(‘woocommerce_order_button_html’, ‘customize_veem_checkout_button_html’);
- PostMessage Handling: The JavaScript code is designed to handle postMessages within the Veem payment flow. By using event listeners to capture ‘onComplete’ and ‘onError’ messages, businesses can effectively manage successful payment completions and promptly address any encountered errors, ensuring a smooth and reliable payment experience for users.
// JavaScript to handle Veem payment postMessageswindow.addEventListener(“message”, receiveMessage, false);
function receiveMessage(event) { if (event.data === “onComplete”) { // Handle the successful completion of the payment // Example: console.log(“Payment completed successfully”); } else if (event.data === “onError”) { // Handle payment errors appropriately // Example: console.log(“An error occurred during the payment process”); }}
9. Troubleshooting
↑ Back to topEncountering an issue? Follow these steps to ensure everything is set up correctly:
- Verify System Requirements: Before troubleshooting, confirm that your site meets the plugin requirements, including WordPress version, PHP version, and WooCommerce installation.
- Isolate Potential Conflicts: To identify and address any plugin conflicts, consider the following steps:
- Temporarily activate the default WooCommerce theme, “Storefront.”
- Deactivate all other plugins except for WooCommerce and Veem Payments.
- Test the plugin’s functionality to determine if the issue persists.
10. Support and Contact Information
↑ Back to topCustomer support is available 24/7.
↑ Back to topGet the service you and your customers deserve with world-class, multilingual support 24/7 via chat, email, and phone. Our dedicated support representatives are ready to answer your questions, help with payment needs, and more.
Follow our support channel for more information.
11. License and Pricing
↑ Back to topLicense: GNU Public License.
Price: Free.