# OpenPath Developers Hub Documentation

> Welcome to the OpenPath Developers Hub, your premier destination for comprehensive insights into seamlessly integrating with OpenPath Applications and APIs. Here, we provide a wealth of resources meticulously crafted to empower developers like you in leveraging our cutting-edge technologies to their fullest potential.

## Guides
- [Create a Free Account](https://developer.openpath.io/docs/create-a-free-accout.md): How to create a free enterprise account in OpenPath.
- [Activating Your Free Account](https://developer.openpath.io/docs/activating-your-trial-account.md): This guide explains how to transition your OpenPath account from the trial version to the live version, enabling you to send real transactions. In the trial version, you can only connect to a test processing account. To upgrade, you need to add your credit card details for payment. This can be done by clicking on the banner displayed at the top of the page or by navigating to the payment methods section in settings. After adding your payment details and accepting the authorization terms, you can start using the full features of OpenPath.
- [WooCommerce](https://developer.openpath.io/docs/woocommerce.md): This is a Quick Guide to setting up Instant Direct Payments in your WooCommerce store
- [Best Practices](https://developer.openpath.io/docs/woo-best-pratices.md): This implementation is applicable to Elementor and Classic UI's
- [Subscriptions](https://developer.openpath.io/docs/subsriptions.md)
- [How to Ensure Customers Click on the Terms of Service (ToS) Checkbox at Checkout in WooCommerce](https://developer.openpath.io/docs/how-to-ensure-customers-click-on-the-terms-of-service-tos-checkbox-at-checkout-in-woocommerce.md): This guide provides step-by-step instructions on configuring WooCommerce checkout settings to make the Terms of Service checkbox mandatory.
- [Shopify](https://developer.openpath.io/docs/shopify.md)
- [Install from OpenPath](https://developer.openpath.io/docs/install-from-openpath.md)
- [Install from Shopify](https://developer.openpath.io/docs/install-from-shopify.md)
- [BigCommerce](https://developer.openpath.io/docs/bigcommerce.md)
- [Install the App](https://developer.openpath.io/docs/install-the-idp-app.md)
- [Magento](https://developer.openpath.io/docs/magento.md)
- [Install OpenPath Extension](https://developer.openpath.io/docs/install-openpath-extension.md)
- [Checkout Champ](https://developer.openpath.io/docs/checkout-champ.md)
- [Recurring Payments on CheckoutChamp](https://developer.openpath.io/docs/recurring-payments.md)
- [Upsells on CheckoutChamp](https://developer.openpath.io/docs/upsells.md)
- [Konnektive](https://developer.openpath.io/docs/konnektive.md)
- [Virtual Terminal](https://developer.openpath.io/docs/virtual-terminal.md): How to use The Virtual Terminal Tool In Openpath Client Page
- [Connectors](https://developer.openpath.io/docs/connectors.md)
- [How to create a Connector?](https://developer.openpath.io/docs/how-to-create-a-connector.md)
- [What is a Connector?](https://developer.openpath.io/docs/what-is-a-connector.md)
- [MAVERICK - Setting up your Webhooks](https://developer.openpath.io/docs/maverick-setting-up-your-webhooks.md)
- [SEAMLESS CHEX - End to End Shopify Installation](https://developer.openpath.io/docs/seamless-chex-end-to-end-shopify-installation.md)
- [SEAMLESS CHEX - Setting up your Webhooks](https://developer.openpath.io/docs/seamless-chex-setting-up-your-webhooks.md)
- [SEAMLESS CHEX - Get a Seamless Chex API Key](https://developer.openpath.io/docs/seamless-chex-get-a-seamless-chex-api-key.md)
- [SEAMLESS CHEX - Setting Up a Connector in OpenPath](https://developer.openpath.io/docs/seamless-chex-setting-up-a-connector-in-openpath.md)
- [Overview](https://developer.openpath.io/docs/overview.md)
- [Quick Start](https://developer.openpath.io/docs/getting-started.md)
- [The Elements](https://developer.openpath.io/docs/the-elements.md)
- [Shipping Element](https://developer.openpath.io/docs/shipping-element.md)
- [Payment Element](https://developer.openpath.io/docs/payment-element.md)
- [Terms Element](https://developer.openpath.io/docs/terms-element.md)
- [Button Element](https://developer.openpath.io/docs/button-element.md)
- [Notification Element](https://developer.openpath.io/docs/notification-element.md)
- [Element Library](https://developer.openpath.io/docs/advance-functions.md)
- [Initialize](https://developer.openpath.io/docs/initialize.md)
- [Attach](https://developer.openpath.io/docs/attach.md)
- [Connect](https://developer.openpath.io/docs/connect.md)
- [Set](https://developer.openpath.io/docs/set.md)
- [BeforeSend](https://developer.openpath.io/docs/begin.md)
- [Receiving Responses](https://developer.openpath.io/docs/receiving-responses.md)
- [Refunds](https://developer.openpath.io/docs/refunds-voids.md)
- [Recurring](https://developer.openpath.io/docs/recurring.md)
- [Update Vaulted Card](https://developer.openpath.io/docs/update-vaulted-card.md)
- [Responses](https://developer.openpath.io/docs/responses-1.md)
- [AVS Response Codes](https://developer.openpath.io/docs/avs-response-codes.md)
- [CVV Response Codes](https://developer.openpath.io/docs/cvv-response-codes.md)
- [Overview](https://developer.openpath.io/docs/odr-overview.md)
- [Test Cards](https://developer.openpath.io/docs/test-cards-odr.md): Test transactions using a primary processor and Decline Recapture with various card numbers. Simulate approvals, full declines, and fallback approvals using Stripe or other sandbox environments. Ensure proper routing by forcing declines on the primary.
- [Configure OpenPath for IDP](https://developer.openpath.io/docs/openpath-config.md)
- [Consumer Testing Flow](https://developer.openpath.io/docs/consumer-testing-flow.md)
- [Test Consumer KYC](https://developer.openpath.io/docs/test-consumer-kyc.md)
- [Test Cards](https://developer.openpath.io/docs/test-cards-idp.md)
- [API Integration IP Whitelisting](https://developer.openpath.io/docs/api-integration-ip-whitelisting.md)
- [Sale, Auth, Credit, Validate](https://developer.openpath.io/docs/sale-auth-credit-validate.md): This guide details payment gateway transaction types, required variables, billing and shipping fields, recurring settings, customer vault use, stored credentials, and Level 2/3 data for API integration.
- [Capture](https://developer.openpath.io/docs/capture.md): Use supported POST formats like Query String (not recommended), Form Data, or X-WWW Form URL Encoded (recommended) for transactions. The capture function allows settlement of authorized transactions, with specific parameters.
- [Void](https://developer.openpath.io/docs/void.md): The Openpath NMI Emulation API supports POST requests in various formats, including query strings and form data. It allows for void transactions, with specific parameters and required fields for processing.
- [Refund](https://developer.openpath.io/docs/refund.md): OpenPath NMI Emulation API supports secure POST requests in multiple formats to process refunds, allowing merchants to reverse settled transactions using minimal, structured parameters.
- [Result Codes](https://developer.openpath.io/docs/result-codes.md): This list defines transaction result codes, indicating approval, pending status, declines, errors, or issues like fraud, expired cards, or communication problems during payment processing.
- [Test Numbers](https://developer.openpath.io/docs/test-numbers.md): Use Openpath's Sandbox mode to test transactions with sample card numbers and ACH data. Simulate errors like declines, AVS/CVV matches, or fatal errors to ensure proper processing and error handling.

## API Reference
- [Transact](https://developer.openpath.io/reference/default-1.md): Describes payment transaction types including sale, auth, capture, void, refund, credit, and validate, detailing their purpose, flow, and rules for settlement, reversal, or verification.
- [Sale or Authorization](https://developer.openpath.io/reference/transaction-sale-auth.md): The Openpath NMI Emulation API accepts transactions via query string, form data, or recommended URL-encoded POST. Responses include metadata in custom headers like PacketId and GatewayName.
- [Capture](https://developer.openpath.io/reference/capture.md): The Openpath NMI Emulation API accepts transactions via query string, form data, or recommended URL-encoded POST. Responses include metadata in custom headers like PacketId and GatewayName.
- [Void](https://developer.openpath.io/reference/post_api-transact-php-6.md): ## Void (void)
 Transaction voids will cancel an existing sale or captured authorization. In addition, non-captured authorizations can be voided to prevent any future capture. Voids can only occur if the transaction has not been settled.
 
 NOTE: Besides the response body, OpenPath will also include our internal payment packet ID, the server which executed the transaction, the OpenPath Payment Provider/Gateway "Connector" ID and the name of that connector in the following format:
 - X-OpenPath-PacketId
 - X-OpenPath-Server
 - X-OpenPath-GatewayId
 - X-OpenPath-GatewayName
- [Refund](https://developer.openpath.io/reference/post_api-transact-php-5.md): ## Refund (refund)
 Transaction refunds will reverse a previously settled or pending settlement transaction. If the transaction has not been settled, a transaction void can also reverse it.
 
 NOTE: Besides the response body, OpenPath will also include our internal payment packet ID, the server which executed the transaction, the OpenPath Payment Provider/Gateway "Connector" ID and the name of that connector in the following format:
 - X-OpenPath-PacketId
 - X-OpenPath-Server
 - X-OpenPath-GatewayId
 - X-OpenPath-GatewayName
- [Create Tokenized Card](https://developer.openpath.io/reference/post_api-transact-php.md): Using the provided credit card information, the system securely stores the data and returns a unique token that can be used for future billing.
- [Update Tokenized Card](https://developer.openpath.io/reference/put_api-transact-php.md): Using the Update Customer, you can update an existing token with new updated billing information.
- [Create Tokenized Card, Customer & Billing](https://developer.openpath.io/reference/post_api-transact-php-1.md): Using the provided credit card, customer and billing information, the system securely stores the data and returns a unique token that can be used for future billing.
- [Sale by Token](https://developer.openpath.io/reference/post_api-transact-php-2.md): When you are ready to rebill an existing token, just pass the Payment Token and the amount and any additional information, for example, line items to process this payment.
- [Sale with Tokenization](https://developer.openpath.io/reference/post_api-transact-php-3.md): If you do not want to Tokenize a card and then process a sale, you can do both action in one call. Create a standard sale and add the stored_credential_indicator to do both the sale and get the new Tokenized information in the transaction result.
- [Find a transaction](https://developer.openpath.io/reference/get_transactions-find.md): Find a transaction within the OpenPath Platform based on the supplied filtered attributes. Note
 that this API Endpoint is designed to find single transactions; however, based on some query
 attributes it may return multiple transactions. For instance, if you search for an Order ID and
 that order has had multiple transactions processed against it, like Authorization, Capture and
 Refund, then you may receive 3 transactions results.

## Changelog
- [FlexFactor Auth, Capture](https://developer.openpath.io/changelog/flexfactor-auth-capture.md)
- [Version 3.5 Build 260411](https://developer.openpath.io/changelog/version-35-build-260411.md)
- [Version 3.5 Build 260409](https://developer.openpath.io/changelog/version-35-build-260409.md)
- [Version 3.5 Build 250407](https://developer.openpath.io/changelog/version-35-build-250407.md)
- [Version 3.5 Build 12161700](https://developer.openpath.io/changelog/version-35-build-12161700.md)
- [Version 3.5 Build 12090400](https://developer.openpath.io/changelog/version-35-build-1209240400.md)
- [Version 3.5 Build 10251928](https://developer.openpath.io/changelog/version-35-build-10251928.md)
- [Version 3.5 Build 10132210](https://developer.openpath.io/changelog/version-35-build-10132210.md)
- [Version 3.5 Build 10071530](https://developer.openpath.io/changelog/version-35-build-10071530.md)
- [Version 3.5 Build 09231540](https://developer.openpath.io/changelog/version-35-build-09231540.md)