Technical Documentation

Technical Merchant Integrations for Digital Freedom

Implementation guidance for hosted checkout, WordPress, WooCommerce, and custom merchant integrations using Digital Freedom payment flows.

Quickstart

Go live in four steps

Typical setup: 20–60 minutes
1

Choose your integration

Select WordPress Button, WooCommerce Gateway, or a custom integration based on your platform and desired control.

2

Prepare merchant credentials

Obtain your Merchant ID, API Key, and Signature Public Key from your Digital Freedom merchant account.

3

Implement the payment flow

Install the plugin or load the hosted JavaScript, then map the required order fields into your checkout.

4

Confirm server-side before fulfillment

Use the signed receipt and your server-side confirmation flow as the authoritative completion step before shipping goods or granting access.

Choose a Path

Select the integration that fits your build

Use the WordPress Button for the fastest launch, the WooCommerce Gateway for native store checkout, or the Custom Integration path when you need your own merchant logic and checkout orchestration.

WordPress

SovPay WordPress Button

Best for simple WordPress pages, fast launches, memberships, one-off offers, and merchants who want a hosted payment button without rebuilding checkout.

  • • Simple shortcode-based placement
  • • Hosted payment launch with merchant-side confirmation
  • • Useful for lightweight pages and fast implementation
WooCommerce

SovPay WooCommerce Gateway

Best for stores already using WooCommerce and merchants who want a payment method integrated into a familiar Woo checkout flow.

  • • Native Woo payment gateway experience
  • • Hosted payment launch with order-aware completion logic
  • • Useful for structured carts, products, and standard checkout pages
Custom API

Merchant-Controlled Integration

Best for custom sites, apps, access systems, and merchants who want tighter control over checkout behavior, server validation, and fulfillment orchestration.

  • • Hosted JavaScript launch with custom field mapping
  • • Signed browser result for user experience and server-side confirmation
  • • Useful for bespoke payment and access workflows
WordPress Integration
Plugin Summary

SovPay WordPress Button

Use a hosted payment button on WordPress pages when you want a simple merchant-controlled entry point into the Digital Freedom payment flow without adopting a full cart platform.

Current Stable Version
1.1.7
Update Channel
Private / Self-Hosted
Best For
Simple payment pages, memberships, one-off offers, and lightweight WordPress implementations
Completion Model
Hosted launch with signed result handling and merchant-side confirmation before fulfillment
What this path is good at
  • • Rapid deployment on WordPress without rebuilding your merchant page architecture.
  • • Hosted payment launch with validated merchant settings and a cleaner path to accepting DF payments quickly.
  • • Simple merchant-side record handling for fulfillment, service access, or follow-up workflows.
Merchant setup essentials
  • • Merchant ID, API Key, and Signature Public Key are required.
  • • Notification email can be used for merchant/store-owner payment notices.
  • • The shortcode title can be customized for page-specific button naming.
WooCommerce Integration
Plugin Summary

SovPay WooCommerce Gateway

Use a native WooCommerce payment method when you want Digital Freedom payments to fit directly into your store checkout while keeping server-side payment completion authoritative.

Current Stable Version
1.2.8
Update Channel
Private / Self-Hosted
Best For
WooCommerce stores, structured product carts, and merchants who want a native gateway approach
Completion Model
Order-aware checkout flow with hosted payment launch and authoritative merchant-side completion
What this path is good at
  • • Preserving a familiar WooCommerce checkout experience while adding a Digital Freedom payment method.
  • • Mapping order totals, descriptions, and fulfillment expectations into a standard store workflow.
  • • Giving merchants a more natural fit for catalog, cart, and order-management driven commerce.
Merchant setup essentials
  • • Merchant credentials are validated in settings before payment launch is enabled.
  • • Checkout title, description, and button text can be adapted to fit store language.
  • • Order completion should still depend on confirmed payment processing, not a browser event alone.
Custom Integration
Official integration path
Use sovpay.js to launch the hosted “Pay with Digital Freedom” experience from your own checkout. The browser-side integration can update the customer experience, but your merchant-side confirmation flow should remain authoritative before fulfillment, access creation, or service delivery.
Integration steps
  1. 1. Identify the checkout field IDs you will map into the sovpay configuration object.
  2. 2. Obtain your API Key and Signature Public Key from Settings → Account Settings → Merchant Information.
  3. 3. Define the sovpay object inside a script block in the page head.
  4. 4. Implement result_handler to respond to the returned payment result.
  5. 5. Load the hosted sovpay.js script and confirm payment server-side before final fulfillment.
Required `sovpay` fields
  • • api_key, merchant_id_field, price_usd_field, desc_field, sovpay_btn_div, intent_field, public_sig_key, and result_handler.
  • • Your checkout should provide merchant_id, amount_usd, description, and a unique intent_id up to 36 characters.
  • • Include both the payment button placeholder sovpay_btn and the hosted form placeholder sovpay_iframe.
Example configuration
const sovpay = {
  api_key: 'YOUR_API_KEY',
  merchant_id_field: 'merchant_id', // field ID containing your Merchant ID
  price_usd_field: 'amount_usd',    // total checkout amount in USD
  desc_field: 'description',        // freeform order description
  sovpay_btn_div: 'sovpay_btn',     // div replaced by the payment button
  intent_field: 'intent_id',        // unique payment ID, max 36 chars
  public_sig_key: `-----BEGIN PUBLIC KEY-----
YOUR_SIGNATURE_PUBLIC_KEY
-----END PUBLIC KEY-----`,
  result_handler: function (result) {
    if (result.status === 'PAID') {
      // Update the customer experience.
      // Complete fulfillment only after your merchant-side confirmation flow accepts the payment.
    } else {
      // Show returned status or error information.
    }
    console.log(result);
  }
};
Hosted script include
<script src="https://account.digitalfreedom.network/js/sovpay.js?version=3"></script>
Example checkout placeholders
<input type="hidden" id="merchant_id" name="merchant_id" value="YOUR_MERCHANT_ID" />
<input type="number" id="amount_usd" name="amount_usd" />
<input type="text" id="description" name="description" maxlength="512" />
<input type="text" id="intent_id" name="intent_id" maxlength="36" />
<div id="sovpay_btn" name="sovpay_btn"></div>
<div id="sovpay_iframe" name="sovpay_iframe"></div>
FAQ

Common merchant questions

What is the fastest way to start?

For most merchants, the WordPress Button is the fastest implementation. WooCommerce is the better fit if you already run a Woo store. Custom integration is best when you need your own checkout logic.

What credentials do I need?

You need your Merchant ID, API Key, and Signature Public Key from your Digital Freedom merchant account.

Should I trust the browser result alone?

No. Use the browser result to improve user experience, but let server-side confirmation remain authoritative before granting access or shipping goods.

Where do I get the plugins?

Each plugin section includes a direct ZIP download button and a release-notes link so merchants can install quickly while still reviewing current package details.