Pular para o conteúdo

Listdom Payments Settings Documentation

Este conteúdo não está disponível em sua língua ainda.

The Payment Settings in Listdom allow you to configure how monetization is handled. Here you can switch between Listdom’s internal payment engine or WooCommerce, define checkout and thank-you pages, set your currency format, customize post-payment messages, design invoice details, and enable/disable payment gateways. If you have monetization add-ons installed (like Claim or Top Up), their options will also integrate into this system.

The first section, Engine, lets you choose between using Listdom’s built-in payment engine or WooCommerce for processing payments. Toggle Listdom Engine on or off to switch modes. Each engine has different requirements and capabilities.

When the Listdom Payment Engine is enabled, Listdom handles all transactions internally (no WooCommerce plugin needed). In this mode, you configure gateways and settings right in Listdom. Make sure to do the following:

  1. Enable Desired Gateways: Go to the Gateways section below and turn on the payment methods you want to offer (e.g. PayPal, On-Site, etc.). Provide any required credentials or instructions for each gateway.
  2. Offline Payment Instructions: If you plan to accept offline payments (like cash or bank transfer), fill in the On-Site and Wire Transfer instructions so customers know how to pay.
  3. Set Currency & Format: Choose your global currency and how prices display. Listdom uses your Default Currency (e.g. USD, EUR) and positions the symbol either before or after the amount based on Currency Position (e.g. $99 vs. 99€).
  4. Configure Checkout Pages: Assign the pages for checkout and thank-you (appreciation) in the Options section. Ensure the required shortcodes ([listdom-checkout] and [listdom-order-summary]) are placed on those pages.
  5. Coupons (Optional): If using Listdom’s coupon system, you can create discount codes under Listdom → Payments → Coupons after setting up payments.

With the Listdom engine active, all payment records are stored in Listdom. Orders appear in Listdom → Payments → Orders, and you can manage everything within the plugin. Administrators can manually confirm offline payments (mark orders as completed) and send out order emails if configured. Review what happens to each transaction in the Orders section. To support recurring memberships, enable Recurring tiers from Pro in your Plans before selling ongoing packages. You can switch back to WooCommerce later if you need a more advanced e-commerce suite.

If you toggle Listdom Engine off, Listdom will defer to WooCommerce for all transactions. In this mode, Listdom creates products in WooCommerce for its paid features (like plans or add-on fees), and all checkout processing happens via WooCommerce’s cart and checkout pages. To use the WooCommerce engine:

  1. Install WooCommerce: Ensure the WooCommerce plugin is installed and activated. Listdom will detect WooCommerce automatically.
  2. Configure WooCommerce Payments: In WooCommerce → Settings → Payments, enable and set up your desired payment gateways (e.g. Stripe, PayPal, etc.). WooCommerce’s own documentation covers adding API keys and configuring each gateway.
  3. WooCommerce Settings: Adjust WooCommerce order email templates, tax rules, and statuses as needed. For example, configure tax rates if applicable and review how order statuses like “Processing” or “Completed” behave.
  4. Create Products for Listdom Features: For each Listdom monetized feature (plans, bookings, etc.), Listdom will expect a corresponding WooCommerce Product. (Listdom can generate these automatically when needed, or you can create them manually and link via settings in relevant add-ons.)
  5. Use WooCommerce Coupons & Reports: In WooCommerce mode, Listdom’s internal coupon system is bypassed. Use WooCommerce → Coupons for promotional codes and rely on WooCommerce’s order management and reports for transactions.

All Listdom charges (listing plans, booking fees, claim fees, etc.) will be processed as WooCommerce orders when using this engine. You’ll manage transactions under WooCommerce → Orders instead of in Listdom. Make sure to map each Listdom feature to a WooCommerce product (see add-on settings for Claim, Top Up, etc., where you select a product). You can switch back to Listdom’s internal engine anytime if you prefer a simpler solution. When you do, revisit the Plans and Recurring Payments docs to confirm your Listdom packages are ready for checkout, including any Pro-powered recurring tiers.

Under Options, you’ll configure essential pages and messages for the checkout process. These selections determine what customers experience after buying a plan in the Payments menu.

Checkout Page: Select the WordPress page that will serve as your checkout. Typically this is a page you’ve created (for example, “Checkout”) with the Listdom Checkout shortcode. Once you assign the page here, insert the shortcode [listdom-checkout] into that page’s content. This page is where users will review their cart and enter payment details. (If using WooCommerce engine, Listdom will redirect users to WooCommerce’s checkout instead.)

Appreciation Page: This is the “Thank You” page users see after a successful payment. Choose a page (often titled “Thank You” or “Order Received”). In that page, you can include the Order Summary shortcode [listdom-order-summary] to display a recap of the order. If no appreciation page is set, users are redirected to the homepage after payment, so setting this is highly recommended.

Appreciation Message: You can write a custom thank-you message that will be shown on the appreciation page after the order is completed. This message appears only if the payment gateway itself does not provide a specific confirmation message. Use it to thank the customer or give next steps. (Example: “Thank you for your purchase! Your listing will be published shortly.”) You can include basic HTML or shortcodes here if needed.

Invoice Button: Choose whether to automatically include an “Download Invoice” button at the end of the appreciation message. By default, this is set to “Append to the message.” If set to “Do not append,” no invoice download link will appear on the thank-you page message (users could still retrieve invoices from their dashboard or email if provided).

Agreement: This rich-text field lets you define terms or an agreement that the user must accept at checkout. The content you enter here will appear as a terms-and-conditions section (usually a checkbox) on the Listdom checkout page. Use this to require customers to agree to your policies (refund policy, terms of service, etc.) before placing an order. For example, you might include: “I agree to the directory listing terms and privacy policy.” If left blank, no agreement checkbox is shown.

Free Checkout Comment: If the cart total is $0 (for instance, a free plan or a 100% discount coupon), Listdom still presents a Complete Purchase button to finalize the zero-cost order. The Free Checkout Comment is a message displayed above that button to reassure or instruct users for free orders. For example, you could enter “No payment is required – confirm to finalize your free listing.” This field supports basic formatting and shortcodes. If left empty, no extra message is shown for free checkouts. Learn how these free purchases appear in the Orders list.

If a user accesses the checkout page with an empty cart (no items to purchase), Listdom displays an “empty cart” message. Here you can customize what that looks like.

  • Empty Cart Image: Upload or select an image to show above the empty cart message. This could be a friendly graphic or icon (e.g. an empty box illustration) to make the page more engaging. If set, the image will appear centered; if left blank, no image is shown.
  • Empty Cart Content: Provide the text or HTML content to display when the cart is empty. This could be a message like “Your cart is empty. Browse our plans and add a listing to get started!” You might include a link back to the listing submission page or pricing page as a call-to-action. Use this content to guide users on what to do next.
  • Show Buttons: Toggle this on to show quick-action buttons under the empty cart message. When enabled, two buttons will appear by default – one linking to the user’s dashboard and another to your site’s homepage, encouraging the user to continue browsing or manage their listings. If you switch this off, those navigation buttons will be hidden, leaving only your custom message (and image) on the empty cart screen.

Listdom can generate a PDF invoice for each order. The Invoice settings let you customize the appearance and info on those invoices.

Invoice Logo: Upload a logo to appear at the top of your invoices. This is typically your company or website logo, and it will be displayed prominently in the header of the PDF invoice. Use a clear, high-resolution image (ideally horizontal orientation) for best results. If you leave this empty, the invoice will simply show the business name text (from the “From” details) without a logo.

Invoice From Details: Enter the business name and contact information that should appear in the “From” section of the invoice (usually in the header area). This might include your company name, address, phone number, email, or tax ID – essentially any information identifying the seller. You can use multiple lines – each new line will be a separate line on the invoice. For example:

Webilia Directory Inc.
1234 Market Street, Suite 100
Cityville, NY 10001
Phone: (123) 456-7890

These details help legitimize the invoice and provide the customer a way to contact you. Make sure to include all legally required info for invoices in your region (like VAT number if applicable).

Additional Information (Invoice Footer): This is an open-ended content field where you can include any extra notes at the bottom of the invoice. The content you enter here will appear in a section often labeled “Additional Information” or as a footer note on the PDF. You might use this to say “Thank you for your business!”, provide refund policy details, or any disclaimer. This field supports rich text, so you can add links or formatting if needed. If you don’t have extra info to provide, you can leave it blank (the section will not appear on the invoice).

The Gateways section (visible only when using the Listdom Payment Engine) is where you enable or disable specific payment methods and enter their settings. Each gateway appears as a subsection with its name as the heading. By default, Listdom includes the following gateways:

Free is an automatic gateway that handles $0 checkouts. There’s no on/off toggle for the Free gateway – it’s always active to process free orders (for example, if a 100% off coupon is applied or a plan costs $0). The Free gateway doesn’t require any configuration beyond the Free Checkout Comment you set in the Content options above. When a user’s cart total is zero, they’ll see a Complete Purchase button (with your comment above it) and can finalize without entering payment details. Upon clicking, the order is marked Completed immediately, which you can confirm in the Orders table.

The On-Site gateway allows customers to pay in person or on site (also known as Cash on Delivery or Pay at Location). Enable this if you want to let users place an order and then pay you offline (e.g., handing cash or swiping a card in person when a service is rendered). After collecting payment, mark the order completed in the Payments menu.

Settings:

  • Status: Toggle the On-Site gateway on or off. When enabled, it will appear as a payment option at checkout.
  • Name: The label for this gateway as shown to users. By default it’s “On-Site,” but you can rename it (e.g., “Pay on Site” or “Pay Upon Arrival”) to fit your use case.
  • Comment: A description or instructions shown to the customer when they select On-Site payment. Here you should provide guidance on how they will complete the payment offline. For example: “You will be contacted to arrange payment in person. No online payment required at checkout.” If you leave this blank, no extra message is shown besides the title.

When a user chooses On-Site, they can place the order without entering any online payment. The order will come through with a Pending status. It’s up to the admin to confirm when payment is received (by editing the order status to Completed). No automatic charge is made.

The Wire Transfer gateway (sometimes labeled as “Bank Transfer”) lets users pay by sending money directly to your bank account. Enable this if you want to accept direct bank payments outside of the website. Provide clear instructions so you can reconcile deposits with entries in the Orders list.

Settings:

  • Status: Toggle to enable Bank/Wire Transfer as a payment option.
  • Name: The label shown at checkout (default “Wire Transfer”). You might rename it “Bank Transfer” or “Direct Bank Payment” if that’s clearer for your audience.
  • Comment: Instructions for the user on how to complete the transfer. This is critical – you should provide your bank account details or a reference. For example: “After placing the order, please transfer the amount to Account #12345678 at ABC Bank, Routing 000111. Use your Order ID as the reference. Your listing will be published once payment is confirmed.” You can format this text with line breaks or small HTML if needed to make it readable.

When a user picks Wire Transfer, they place the order without paying immediately. The order status will be On-Hold or Pending (depending on Listdom’s logic, typically pending). You as the admin will then wait for the offline transfer to arrive. Once you verify the funds, you should manually mark the order as Completed. Until then, services related to the order (like publishing a listing or approving a booking) may be held in pending status.

PayPal integration is built-in. Enabling this lets customers pay using their PayPal account or credit card via PayPal.

Settings:

  • Status: Toggle to enable PayPal. If enabled, PayPal will appear as a payment choice on the Listdom checkout.
  • Name: The payment method name shown to users (default “PayPal”). Usually you keep this as “PayPal” for brand recognition.
  • Comment: (Optional) A message to customers about PayPal. For example, “You will be redirected to PayPal to complete payment securely.” If left blank, a default note may be shown or just the PayPal name.
  • Client ID: Required. Your PayPal REST API Client ID. This identifies your PayPal application/merchant account.
  • Secret: Required. Your PayPal API Secret. Along with the Client ID, this allows Listdom to communicate with PayPal’s API to create and verify payments.
  • Mode: Choose “Sandbox” for testing or “Live” for real transactions. Sandbox mode will use PayPal’s sandbox environment (you’ll need sandbox API credentials for testing).

Once configured, customers who choose PayPal will be prompted to log in to PayPal or enter card details through PayPal’s pop-up/redirect. After they complete the payment, Listdom will verify the transaction automatically. Successful PayPal orders are marked Completed (Listdom checks that the PayPal status is “COMPLETED”). If verification fails or the payment isn’t completed, the order will remain in Pending status, which you can review under Orders.

If you have the Listdom Pro addon installed, you can enable Stripe as a gateway. Stripe allows users to pay by credit/debit card directly on your site.

Settings: (These fields appear once Pro is active and the Stripe gateway is added)

  • Status: Toggle to enable Stripe.
  • Name: Label as seen by users (default “Stripe” or “Credit Card”). You might label it “Credit/Debit Card” for clarity.
  • Comment: Message to users. Example: “Pay securely by card. All major credit cards accepted via Stripe.” This can be left blank or used to reassure about security.
  • Publishable Key: Required. Your Stripe API publishable key (starts with “pk_live_…” in live mode). This is used on the frontend.
  • Secret Key: Required. Your Stripe secret key (starts with “sk_live_…” for live). This stays on your server to create charges.
  • Webhook Secret: (Optional but recommended) If provided, Listdom can listen for Stripe webhook events (like membership renewals or refunds). Enter the Signing Secret from your Stripe webhook setup here to verify incoming webhooks.
  • Mode: Stripe doesn’t have a formal sandbox toggle like PayPal’s mode. Instead, you use your Test API keys for test mode. If you input Stripe’s test keys (starting with “pk_test_” / “sk_test_”), the gateway effectively runs in test mode. Using live keys runs real transactions.

With Stripe enabled, a card payment form will appear on the Listdom checkout when users choose this option. Listdom handles tokenizing the card and confirming the payment via Stripe’s API. Successful payments will automatically mark orders Completed. If a payment fails, the user will be prompted to try again or use another method.

Listdom’s flexible gateway system means additional gateways can be added via add-ons or custom code. For example, certain regional gateways or wallet systems could appear if you have a specific add-on. Configuration for those would be similar: enabling the status and filling any required credentials. Always refer to the specific addon’s documentation for any extra gateway.

One notable integration: if you use Paid Member Subscriptions or MemberPress via their respective Listdom add-ons, you won’t configure payment gateways in Listdom at all. Those add-ons tie Listdom’s monetization to the membership plugin’s checkout. In such cases, gateway settings are managed entirely in the membership plugin’s settings.