> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paysight.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API Introduction

> Welcome to the Paysight API Reference. Here, you'll find comprehensive documentation for integrating and using Paysight's powerful APIs to manage payment processing, customer interactions, and more.

# Paysight API Reference

Unlock payment processing, customer management, and automation with Paysight’s secure APIs, built for rapid integration whether you’re launching a new project, scaling a platform, or adding payments to your app.

### Getting Started

<Steps>
  <Step title="Access to your Paysight account">
    Contact your account manager to get access. <br />
    -> [Paysight Login](https://app.paysight.io/auth/login)
  </Step>

  <Step title="Set up API credentials">
    You can check your API credentials by navigating to: <br />
    **`Settings` > `Account` > Under `API Access` section**
  </Step>

  <Step title="Choose your API">
    Select the appropriate API based on your integration needs.

    <CardGroup cols={2}>
      <Card title="Card API" icon="credit-card" href="/api-reference/card-submit/card/submit-card-and-customer-info-for-a-product">
        Process payments, manage refunds, and handle card transactions.
      </Card>

      <Card title="Customer Service API" icon="users" href="/api-reference/customer-service-api/search">
        Manage customer profiles, subscriptions, and service-related operations.
      </Card>

      <Card title="Admin API" icon="user-tie" href="/api-reference/admin-api/">
        Manage merchant accounts and transactions.
      </Card>

      <Card title="Mitigation API" icon="money-bill-transfer" href="/api-reference/mitigation-api/api-for-chargeback-mitigation-providers/search">
        Automate chargeback handling, dispute management, and mitigation workflows.
      </Card>
    </CardGroup>
  </Step>

  <Step title="Start integrating">
    Use the API reference documentation to implement your custom
    integration.
  </Step>
</Steps>

<Tip>
  Looking for integration guides? Check out the [CRM
  Guides](/guides/introduction) section for step-by-step instructions.
</Tip>

## Our APIs

<Tabs>
  <Tab title="Card API">
    The **Paysight Card API** allows developers to securely manage card transactions within their applications. Whether you're processing payments, handling refunds, or managing chargebacks, this API offers a simple yet robust interface for all card-related operations.

    <Note>
      **The Card API follows a simple flow: Your application sends a payment request to:** <br />
      Paysight API → Paysight processes the payment with the payment processor → The API returns a response with the transaction result → Your application handles the response accordingly.
    </Note>

    <CardGroup cols={2}>
      <Card title="Key Features" icon="star">
        <ul className="mt-2 list-disc list-inside space-y-2 text-sm">
          <li>Process card payments with ease</li>
          <li>Manage refunds and chargebacks efficiently</li>
          <li>Secure transaction handling with industry-standard encryption</li>
          <li>Support for various payment methods and currencies</li>
        </ul>
      </Card>

      <Card title="Use Cases" icon="lightbulb">
        <ul className="mt-1 text-sm list-disc list-inside space-y-2">
          <li>Integrate card payment processing for your e-commerce store</li>
          <li>Automate refund handling for customer transactions</li>
          <li>Track and manage chargeback disputes directly from your system</li>
          <li>Build custom checkout experiences</li>
        </ul>
      </Card>
    </CardGroup>

    <AccordionGroup>
      <Accordion title="Common Endpoints" icon="code">
        <CardGroup cols={2}>
          <Card title="POST" icon="plus">
            `/payments` <br />
            Create a new payment transaction
          </Card>

          <Card title="GET" icon="magnifying-glass">
            `/payments/{id}` <br />
            Retrieve details of a specific payment
          </Card>

          <Card title="POST" icon="rotate-left">
            `/payments/{id}/refund` <br />
            Process a refund for a payment
          </Card>

          <Card title="GET" icon="list">
            `/payments` <br />
            List all payments with filtering options
          </Card>
        </CardGroup>
      </Accordion>

      <Accordion title="Sample Request" icon="code-branch">
        <CodeGroup>
          ```json cURL theme={null}
              curl -X POST https://api.paysight.io/v1/payments \\
              -H "Authorization: Bearer YOUR_API_KEY" \\
              -H "Content-Type: application/json" \\
              -d '{
                "amount": 1.00,
                "currency": "USD",
                "payment_method": {
                  "type": "card",
                  "card": {
                    "number": "4242424242424242",
                    "exp_month": 12,
                    "exp_year": 2027,
                    "cvc": "123"
                  }
                },
                "description": "Payment for order #1234"
              }
          ```

          ```javascript Node.js theme={null}
            const axios = require('axios');

            const createPayment = async () => {
              try {
                const response = await axios.post(
                  'https://api.paysight.io/v1/payments',
                  {
                    amount: 1.00,
                    currency: 'USD',
                    payment_method: {
                      type: 'card',
                      card: {
                        number: '4242424242424242',
                        exp_month: 12,
                        exp_year: 2027,
                        cvc: '123'
                      }
                    },
                    description: 'Payment for order #1234'
                  },
                  {
                    headers: {
                      'Authorization': 'Bearer YOUR_API_KEY',
                      'Content-Type': 'application/json'
                    }
                  }
                );

                console.log(response.data);
              } catch (error) {
                console.error(error);
              }
            };
            createPayment();
          ```
        </CodeGroup>
      </Accordion>
    </AccordionGroup>

    <Tip>
      For detailed specifications and example requests, check out the full [Card API documentation](/api-reference/card-submit/card/submit-card-and-customer-info-for-a-product).
    </Tip>
  </Tab>

  <Tab title="Customer Service API">
    **Paysight Customer Service API** is designed to help businesses manage customer data and interactions more effectively. From creating and updating customer profiles to tracking orders and subscriptions, this API provides all the tools you need to keep customer relationships running smoothly.

    <CardGroup cols={2}>
      <Card title="Key Features" icon="star">
        <ul className="mt-2 list-disc list-inside space-y-2 text-sm">
          <li>Create, retrieve, update, and delete customer data</li>
          <li>Manage customer subscriptions and orders</li>
          <li>Track customer payment methods and preferences</li>
          <li>Seamlessly integrate customer service workflows</li>
        </ul>
      </Card>

      <Card title="Use Cases" icon="lightbulb">
        <ul className="mt-1 text-sm list-disc list-inside space-y-2">
          <li>Build and manage customer profiles in your application</li>
          <li>Automate subscription management and renewal processes</li>
          <li>Keep track of customer orders and payment history</li>
          <li>Streamline your customer service operations</li>
        </ul>
      </Card>
    </CardGroup>

    <AccordionGroup>
      <Accordion title="Common Endpoints" icon="code">
        <CardGroup cols={2}>
          <Card title="POST" icon="plus">
            `/customers` <br />
            Create a new customer profile
          </Card>

          <Card title="GET" icon="magnifying-glass">
            `/customers/{id}` <br />
            Retrieve a specific customer's details
          </Card>

          <Card title="PUT" icon="pen">
            `/customers/{id}` <br />
            Update a customer's information
          </Card>

          <Card title="GET" icon="calendar">
            `/customers/{id}/subscriptions` <br />
            List a customer's subscriptions
          </Card>
        </CardGroup>
      </Accordion>
    </AccordionGroup>

    <Tip>
      For a complete breakdown of endpoints and usage instructions, explore the [Customer Service API documentation](/api-reference/customer-service-api/search).
    </Tip>
  </Tab>

  <Tab title="Admin API">
    **Paysight Admin API** lets you manage your entire payment setup, so you don’t have to do everything manually in a dashboard.

    <CardGroup cols={2}>
      <Card title="Key Features" icon="star">
        <ul className="mt-2 list-disc list-inside space-y-2 text-sm">
          <li>Create and update merchant accounts, track transactions, and manage compliance.</li>
          <li>Control users, roles, and permissions across the platform.</li>
          <li>Access activity logs to ensure compliance and audit trails.</li>
          <li>Perform batch actions for multi-merchant onboarding and user sync.</li>
        </ul>
      </Card>

      <Card title="Use Cases" icon="lightbulb">
        <ul className="mt-1 text-sm list-disc list-inside space-y-2">
          <li>Onboard new merchants automatically instead of filling out forms manually.</li>
          <li>Search transactions with filters (by date, amount, or status) for reporting or troubleshooting.</li>
          <li>Give or remove team access, adding new users or locking down unused accounts.</li>
          <li>Stay audit-ready by keeping logs of who did what, and when.</li>
        </ul>
      </Card>
    </CardGroup>

    <AccordionGroup>
      <Accordion title="Common Endpoints" icon="code">
        <CardGroup cols={2}>
          <Card title="POST" icon="plus">
            `/api/admin/merchantaccounts`
            Create a new merchant account
          </Card>

          <Card title="GET" icon="magnifying-glass">
            `/api/admin/merchantaccounts{id}`
            Retrieve a specific merchant account
          </Card>

          <Card title="PUT" icon="pen">
            `/api/admin/merchantaccounts{id}`
            Update a merchant account
          </Card>

          <Card title="POST" icon="magnifying-glass-dollar">
            `api/transactions/search`
            Advanced transaction search
          </Card>
        </CardGroup>
      </Accordion>
    </AccordionGroup>

    <Tip>
      Explore the [Admin API](/api-reference/admin-api/merchantaccounts/) for breakdown of endpoints and more information about them including advanced transaction search.
    </Tip>
  </Tab>

  <Tab title="Mitigation API">
    The **Paysight Customer Service API** is designed to help businesses manage customer data and interactions more effectively. From creating and updating customer profiles to tracking orders and subscriptions, this API provides all the tools you need to keep customer relationships running smoothly.

    <CardGroup cols={2}>
      <Card title="Key Features" icon="star">
        <ul className="mt-2 list-disc list-inside space-y-2 text-sm">
          <li>Search and filter transactions and disputes to identify chargebacks and alerts efficiently.</li>
          <li>Issue refunds automatically and manage customer notifications as soon as mitigation alerts are received.</li>
          <li>Retrieve and update customer subscriptions linked to disputed or refunded transactions.</li>
          <li>Perform batch actions for unsubscribing users or processing multiple mitigation events at scale.</li>
        </ul>
      </Card>

      <Card title="Use Cases" icon="lightbulb">
        <ul className="mt-1 text-sm list-disc list-inside space-y-2">
          <li>Automate chargeback responses by refunding and updating subscriptions when an alert is received.</li>
          <li>Find disputed transactions faster using customer email, card details, or order info.</li>
          <li>Unsubscribe customers automatically when a dispute or refund is processed, reducing future risk.</li>
          <li>Run bulk searches and reports on chargeback or alert trends for compliance and analytics.</li>
        </ul>
      </Card>
    </CardGroup>

    <AccordionGroup>
      <Accordion title="Common Endpoints" icon="code">
        <CardGroup cols={2}>
          <Card title="POST" icon="magnifying-glass">
            `/api/mitigation/search` <br />
            Search for mitigation related transactions and disputes
          </Card>
        </CardGroup>
      </Accordion>
    </AccordionGroup>

    <Tip>
      For a complete breakdown of endpoints and usage instructions, explore the [Mitigation API](/api-reference/mitigation-api/api-for-chargeback-mitigation-providers/search).
    </Tip>
  </Tab>
</Tabs>

## Authentication

<Tabs>
  <Tab title="Bearer Token">
    All API endpoints are authenticated using Bearer tokens. Include your API
    key in the Authorization header of each request: `bash Authorization:
            Bearer YOUR_API_KEY `
  </Tab>

  <Tab title="API Keys">
    You can manage your API keys in the Paysight CRM dashboard:

    <Steps>
      <Step title="Login to Paysight">
        Login to your Paysight Account <br />
        -> [Paysight Login](https://app.paysight.io/auth/login)
      </Step>

      <Step title="Find your API key">
        Check your API credentials by navigating to: <br />
        **`Settings` > `Account` > Under `API Access` section**

        <Danger>
          Keep your API keys secure and never expose them in client-side code or public repositories.
        </Danger>
      </Step>

      <Step title="Copy and Secure">
        Copy the generated key and store it securely.
      </Step>
    </Steps>
  </Tab>
</Tabs>

### Rate Limits

<Info>
  To ensure system stability and fair usage, the Paysight API implements rate
  limiting. Standard accounts are limited to 100 requests per minute. If you
  need higher limits, please contact our support team.
</Info>

## Next Steps

<CardGroup cols={3}>
  <Card title="Card API Reference" icon="credit-card" href="/api-reference/card-submit/card/submit-card-and-customer-info-for-a-product">
    Explore the complete Card API documentation.
  </Card>

  <Card title="Customer Service API" icon="users" href="/api-reference/customer-service-api/search">
    Dive into the Customer Service API details.
  </Card>

  <Card title="Widget SDK" icon="code" href="/widget-sdk/introduction">
    Consider using our Widget SDK for simpler integrations.
  </Card>
</CardGroup>