> For the complete documentation index, see [llms.txt](https://help.alternativepayments.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.alternativepayments.io/getting-started/api-introduction.md).

# API Introduction

A brief introduction to using the Alternative Payments API to build custom payment and billing workflows.

#### Introduction to the Alternative Payments API

The Alternative Payments API provides a secure, standards-based interface for partners to integrate payment and billing operations directly into their own systems. Rather than clicking through a dashboard, your applications can create customers, generate payment experiences, issue invoices, track transactions, and reconcile payouts programmatically.

Unlike payment gateways that only handle a single transaction flow, this API is designed for service businesses and platforms that want deeper control over how payments and billing data move through their software stack.

***

#### What the API Enables

At a glance, the Alternative Payments API lets you:

• Create and manage customer records and associated payment methods.\
• Generate hosted payment links for one-off charges or invoice-based billing.\
• Create, retrieve, and manage invoices with line items and PDF links.\
• Track payments with filters for status, type, customer, or invoice.\
• Access payout information and reconcile which transactions were included.

All interactions are done over REST with JSON, authenticated via OAuth 2.0 client credentials using API keys.

This setup gives you the flexibility to automate routine billing work, bring payment workflows into internal systems, or build custom user experiences. It’s not about replacing your dashboard; it’s about extending it into the tools your business already uses.

***

#### Next Steps

For complete technical details including how to authenticate, example requests, available endpoints, and error handling, see the full API documentation:

{% embed url="<https://docs.alternativepayments.io/>" %}

**Love our platform?** Check out our [Referral Program page](https://www.alternativepayments.io/referral-partners/)!


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.alternativepayments.io/getting-started/api-introduction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
