RailbedDocs

Connect Railbed to your store

Choose the connection that fits your business, from a WordPress plugin to a checkout built by your developer.

On this page

Choose a supported connection

Open Integrations to see the current options. The ready-made store plugin is Railbed for WooCommerce. For other websites, use a hosted checkout, a buy button, a widget or a custom API integration.

Your setupStart here
No website, or occasional invoicesPayment links
A website with an HTML or custom-code blockWidgets and buy buttons
A WordPress store using WooCommerceInstall the Railbed for WooCommerce plugin
A custom store, app or gameGive your developer the API quickstart

For a different store platform, choose a website embed or ask your developer to use the API.

Install WooCommerce

The plugin requires WordPress 6.9 or later, WooCommerce 10.9 or later and PHP 8.3 or later. It supports classic checkout and Checkout Blocks. Use HTTPS for the store, including Test mode outside a local WordPress environment.

  1. Download the plugin ZIP from Integrations in Railbed.
  2. In WordPress, open Plugins → Add new → Upload plugin. Upload and activate it alongside WooCommerce.
  3. Open WooCommerce → Settings → Payments → Railbed, and start in Test mode.
  4. In Railbed, switch to Test mode, open Developers and choose Create key. Add an endpoint using the webhook address shown by the plugin.
  5. Copy the Test API key and the endpoint signing secret into the plugin's matching Test fields, then save. Keep both values private.
  6. Send a Test event from Railbed. Reload the plugin settings, confirm Connection verified, and tick Enable to offer Railbed at checkout.
  7. Place a Test order and complete Simulate successful payment. Confirm the order changes to Processing, or Completed for an order whose items are all virtual and downloadable.

The WooCommerce guide contains the connection details, requirements and recovery notes. Keep that guide open alongside the plugin settings.

Move the store to Live

Confirm your payout wallet, then repeat the connection setup using a Live key, a Live endpoint and the plugin's Live fields. A Live endpoint uses Send ping rather than a simulated payment event. Keep the Enable setting on only when the connection has been verified and you are ready to accept customers.

Test orders retain their Test mode when you change the plugin mode. A mode switch does not turn an old Test order into a real payment.

What connects the payment to the order

The plugin creates a payment for the order, directs the customer to checkout, and verifies the result before marking the order paid. A signed webhook starts the check; the plugin then retrieves the payment through the authenticated API.

The customer's return to the store is not the proof that releases an order. If the store and Railbed disagree, compare the payment ID, mode and status, then check webhook delivery and WordPress cron. See Troubleshooting.

Follow store orders and customers

With Railbed for WooCommerce 1.1 or later, new checkouts also send the purchase details to Orders and the buyer details to Customers. The order can include item quantities and variants, coupon discounts, shipping, tax, addresses and a link back to WooCommerce.

Manage fulfilment in WooCommerce. Completed marks the linked Railbed order fulfilled; moving it back to Processing or On hold marks it not fulfilled. Updates run in the background and retry when Railbed cannot be reached. If an update still fails, inspect the order's private note and use Order actions → Send fulfilment status to Railbed.

Orders placed before the 1.1 upgrade are not linked for this fulfilment sync. If a store extension makes the line totals inconsistent, the plugin can send the order as a single total instead; check its private order note and the WooCommerce order for the original breakdown. The payment confirmation process still applies.

The WooCommerce developer guide covers upgrade and sync details. A custom API integration can provide the same order and customer information when creating a session.

Give your developer the right resources

You do not need to learn the API to use payment links. When you need automatic order delivery, a custom purchase screen, or customer-account metadata, share these guides with the person connecting your system:

Create keys and endpoints in the matching mode. API keys and signing secrets belong in your server or store configuration, never in a public web page, widget snippet or customer message.

Updated · This page as Markdown