@blockia-pay/checkout-sdk

Frontend SDK for merchants and developers to integrate Blockia Pay Checkout into their web applications. It enables easy creation of payment records and redirection to the Blockia checkout experience.

📦 Installation

npm install @blockia-pay/checkout-sdk
# or
yarn add @blockia-pay/checkout-sdk
# or
pnpm add @blockia-pay/checkout-sdk

⚡ Quick Start

import { BlockiaCheckout } from '@blockia-pay/checkout-sdk';

const checkout = new BlockiaCheckout({
  secretKey: 'sk_live_...',
  baseApiUrl: 'http://localhost:3000',
});

// On button click
async function handleCheckout() {
  const payment = await checkout.createPayment({
    amount: 49.99,
    description: 'Premium Plan - Monthly',
  });

  checkout.redirectToCheckout(payment.url);
}

🧩 React Checkout Button

If you're using React, the SDK also provides a CheckoutButton component for a creation of a payment link and redirect to it, you can also now add optional parameters like cancel url or success url so you will be redirected to another page after successful or unsuccessful payment.

Example

import React from 'react';
import { CheckoutButton } from '@blockia-pay/checkout-sdk/react/CheckoutButton';

export default function App() {
  return (
    <CheckoutButton
      secretKey="sk_live_..."
      baseApiUrl="https://api.blockia.io"
      amount={49.99}
      description="Premium Plan - Monthly"
      label="Pay with Blockia"
      onSuccess={() => alert('Payment successful!')}
      onFailure={() => alert('Payment failed!')}
      style={{
        backgroundColor: '#6C63FF',
        color: '#fff',
        borderRadius: '8px',
        padding: '0.75rem 1.5rem',
      }}
    />
  );
}

🧬 API Reference

Constructor

new BlockiaCheckout(config: BlockiaCheckoutConfig)

Initializes the SDK with your API secret key and (optionally) base URL.

Methods

createPayment(paymentData)

Creates a new payment record with the specified amount and description.

redirectToCheckout(url)

Redirects the browser to the Blockia Checkout page.

⚠️ Error Handling

The SDK throws typed errors extending BlockiaError:

• ValidationError – Missing or invalid configuration
• LinkError – Failed to create or fetch a payment record

🧪 License

MIT © Blockia Labs