Use PayPortal as your checkout

Step 2 – Backend example (Node / Express)

This is an example of how your backend can call PayPortal using your API key. You can adapt this to any server framework or language.

// Node/Express example
import express from "express";
import fetch from "node-fetch";

const app = express();
app.use(express.json());

// Keep your PayPortal API key on the server only
const PAYPORTAL_API_KEY = "pk_YourPortalKeyHere";

app.post("/create-payportal-checkout", async (req, res) => {
  try {
    const payload = req.body; // { amount, note, customer, cart }

    const ppRes = await fetch("https://api.payportal.uk/v1/checkout-session", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "x-api-key": PAYPORTAL_API_KEY
      },
      body: JSON.stringify(payload)
    });

    const data = await ppRes.json();

    if (!ppRes.ok || !data.checkoutUrl) {
      console.error("PayPortal error:", data);
      return res.status(500).json({ error: "PayPortal checkout failed" });
    }

    // Forward only what the front end needs
    res.json({
      checkoutUrl: data.checkoutUrl,
      sessionId: data.sessionId,
      baseAmount: data.baseAmount
    });
  } catch (e) {
    console.error(e);
    res.status(500).json({ error: "Server error" });
  }
});

// Start your server
app.listen(3000, () => {
  console.log("Server listening on http://localhost:3000");
});

Step 3 – Match PayPortal sessions to your orders

If you run your own order system, you may want to link your internal order to the PayPortal payment. There are two easy ways to do this.

Option 1 – Use the note field

Set the note to your internal order number or identifier:

const payload = {
  amount: cartTotal,
  note: "Order #" + internalOrderId,
  ...
};

This note appears in the PayPortal dashboard when you view the transaction details, so you can quickly match them.

Option 2 – Store the sessionId

When you create a checkout session, PayPortal returns sessionId. You can store that on your side next to the order.

const data = await res.json();
saveOrder({
  orderId: internalOrderId,
  payportalSessionId: data.sessionId
});

Later, when you look at the PayPortal dashboard, you can search by sessionId to match an order.

Step 4 – View payments and mark orders fulfilled

• When a customer starts checkout, the status is pending.
• Once we confirm payment, the status becomes completed.
• You can log into your PayPortal merchant dashboard to see completed transaction count, settled totals, statuses and order details (customer info and cart items).
• You can mark an order as fulfilled in the dashboard after you ship or deliver it.

Security notes

• Never put your PayPortal API key in browser-side JavaScript or public HTML.
• Keep your API key on your server and call PayPortal from your backend only.
• Use HTTPS on your site, especially on checkout or account pages.
• Do not expose any private keys or wallets in your code.

Support

If you get stuck integrating PayPortal, send us:

• Your website URL.
• The code snippet you are using to call your backend endpoint (for example /create-payportal-checkout).
• The exact error message or screenshot of the browser console or network tab.

We can usually tell what is wrong just from that.