Getting Started

This guide will help you get started with Flintn quickly.

Prerequisites

Before you begin, make sure you have:

• A Flintn account at hub.sandbox.flintn.com (sandbox) or hub.flintn.com (production)

• API credentials with appropriate permissions

Quick Start

1. Create Your Account

Sign up at hub.sandbox.flintn.com to get started with the sandbox environment. This allows you to test your integration without processing real payments.

2. Generate API Keys

1. Navigate to Developers > API Keys

2. Click Create API Key

3. Select the permissions your integration needs

4. Copy and securely store your API key

See Authentication for detailed instructions.

3. Set Up Webhooks

Configure webhook endpoints to receive real-time notifications:

1. Navigate to Developers > Webhooks

2. Add your endpoint URL

3. Select the events you want to receive

4. Copy your webhook secret for signature verification

See Configure Webhooks for setup details.

4. Create a Subscription Plan

Define your pricing and billing terms by creating a subscription plan:

• Via Dashboard - Visual interface

• Via API - Programmatic creation

5. Integrate the Payment Checkout

Add the Flintn payment checkout to your page:

npm install flintn-checkout

import { FlintNPayment } from 'flintn-checkout';

const payment = new FlintNPayment({
  config: {
    clientSessionId: 'your_client_session_id',
  },
  onPayment: (result) => {
    if (result.status === 'PAYMENT_SUCCESS') {
      console.log('Payment succeeded:', result.data);
    } else {
      console.log('Payment failed:', result.error);
    }
  },
});

payment.mount('#payment-container');

See Payment Checkout for complete integration details.

Environments

Environment	Dashboard	API Base URL	Use For
Sandbox	hub.sandbox.flintn.com	api.sandbox.flintn.com/v1	Development & testing
Production	hub.flintn.com	api.flintn.com/v1	Live payments

Next Steps

Choose your path based on what you want to build:

Accept Subscription Payments

Follow our step-by-step Subscription Payments Quickstart to accept your first recurring payment.

Understand Core Concepts

Learn about Subscription Plans and Retry Strategies to understand how Flintn handles recurring billing.

Explore the API

Check out the API Reference for complete endpoint documentation.

Getting Help

• Review our Testing Guide for sandbox test cards

• Check API Responses for error handling

• Contact support with your request_id for API issues