> For the complete documentation index, see [llms.txt](https://aliniex.gitbook.io/alix-pay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://aliniex.gitbook.io/alix-pay/api-reference/card-api/overview.md).

# Overview

## Introduction

The Alix Card API enables you to create, manage, and control Visa and Mastercard cards programmatically.

It is designed for modern fintech applications that need secure, on-demand card issuance, flexible spending control, and real-time transaction visibility.

Whether you're issuing cards for end-users, managing balances, or integrating payment flows, this API provides the essential foundation for building scalable, compliant financial experiences.

## Core concepts

#### **Account**

Represents the end-user or entity that owns one or more cards. Each account must complete KYC verification before any card can be issued.

#### Card

A Visa or Mastercard issued under a specific account. Each card includes a unique number, expiration date, CVV, and configurable spending limits (daily, monthly, or per-transaction).

Cards can be created, frozen, updated, or terminated via the API.

#### Transaction

Represents any financial operation — such as an authorization, capture, refund, or reversal — performed using a card.

Each transaction has a lifecycle (pending → completed) and can trigger webhook events for real-time tracking.

#### Top-up

Represents the process of adding funds to an account’s wallet.

Your application can call the Top-up API to transfer funds into a customer’s card, allowing their cards to be used for payments.

## API Design

The API is designed around two key principles:

#### **RESTful and Semantic Endpoints**

Every endpoint follows standard REST conventions and uses clear, resource-oriented URLs.\
Actions are expressed through HTTP methods (`GET`, `POST`, `PATCH`, `DELETE`) rather than verbs in the path, making requests easy to read and predictable to integrate.

#### **Clear and Consistent Response Structure**

All responses share the same structure with three fields:

* `errorCode` — a standardized string identifier for runtime or business errors.
* `message` — a human-readable description of the result or issue.
* `data` — the actual response payload when the request succeeds.

## Environments


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://aliniex.gitbook.io/alix-pay/api-reference/card-api/overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.