Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.halliday.xyz/llms.txt

Use this file to discover all available pages before exploring further.

The fastest way to implement Halliday Payments is by utilizing the widget user interface.

Try the Halliday Payments SDK Widget

Following this guide, or the Widget Documentation guide will result in an onramp expeirence like the following. Try out onramping to an external wallet with this button:

Integrate Halliday Payments

Follow these steps to integrate Halliday Payments in just a few minutes.
1

Obtain API Keys

To get set up with API access for Halliday Payments, get a free API key at dashboard.halliday.xyz.
2

Integrate

First, install the Halliday Payments SDK into a web project.
copy
npm install @halliday-sdk/payments
Next, integrate Halliday Payments into an existing application with a few lines of code. This example is in a React.js project with Wagmi.
copy
import { useEffect } from "react";
import { openHallidayPayments } from "@halliday-sdk/payments";
import { connectWalletClient } from "@halliday-sdk/payments/viem";
import { useAccount, useWalletClient } from "wagmi";

export default function App() {
  const { address, isConnected } = useAccount();
  const { data: walletClient, isSuccess } = useWalletClient();

  useEffect(() => {
    if (!isConnected || !isSuccess || !walletClient || !address) return;

    const userWallet = connectWalletClient(() => walletClient);

    openHallidayPayments({
      apiKey: HALLIDAY_API_KEY,
      outputs: ["base:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"],
      targetElementId: "halliday",
      destinationAddress: address,
      userWallet,
    });
  }, [isConnected, isSuccess, walletClient, address]);

  return <div id="halliday" />;
}
Run the app page and try onramping or swapping tokens with the newly implemented Halliday Payments Payments Widget. Try it now using the button above.