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

# Introduction

> Integrate payments and payouts with the YIĞIM Payment Platform

# YIĞIM API

YIĞIM provides a unified API for accepting payments, managing transactions, issuing refunds, and sending payouts.

<Note>
  The URLs and credentials in this starter project are examples. Replace them with your actual YIĞIM Sandbox and Production values.
</Note>

## Environments

### Sandbox

```text theme={null}
https://sandbox-api.yigim.az
```

### Production

```text theme={null}
https://api.yigim.az
```

## Core concepts

### Intent

An **Intent** represents the merchant's intention to perform a payment operation.

### Transaction

A **Transaction** represents a financial operation, such as payment, capture, void, refund, or payout.

### Authentication

An **Authentication** represents customer authentication associated with a transaction, including 3-D Secure when applicable.

## Typical payment flow

1. Create a payment Intent.
2. Redirect the customer to the payment page.
3. Authenticate the customer when required.
4. Process the transaction.
5. Receive the result.
6. Receive the final webhook event.

<CardGroup cols={2}>
  <Card title="Quickstart" href="/quickstart">
    Make your first test request.
  </Card>

  <Card title="Authentication" href="/authentication">
    Learn how API authentication works.
  </Card>

  <Card title="Payments" href="/payments/overview">
    Understand the payment lifecycle.
  </Card>

  <Card title="Webhooks" href="/webhooks/overview">
    Receive asynchronous transaction updates.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.