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

# Quick Start

## :sparkles:Step by step

Follow these steps and you will have a working payment link in minutes:

{% stepper %}
{% step %}

### Generate an API Key

Log in to the Partner Dashboard and go to **Team Preferences > API Keys**. Create a new key to identify your integration.

[<mark style="background-color:purple;">API Key</mark>](https://docs.alternativepayments.io/getting-started/quick-start/api-keys.md)
{% endstep %}

{% step %}

### Authenticate via OAuth 2.0

Use the API Key to obtain an access token using the **client credentials** grant type.

[<mark style="background-color:purple;">OAuth Authentication</mark>](https://docs.alternativepayments.io/getting-started/quick-start/guides.md#get-oauth-token)
{% endstep %}

{% step %}

### **Create a payment request**

Use your access token to create a new payment request with the desired amount, currency, and redirect URL.

[<mark style="background-color:purple;">Create a payment request</mark>](https://docs.alternativepayments.io/getting-started/quick-start/guides.md#create-payment-request)
{% endstep %}

{% step %}

### **Check payment status**

Poll the API to retrieve the current status of the payment.

[<mark style="background-color:purple;">Retrieve a Payment Request</mark>](https://docs.alternativepayments.io/getting-started/quick-start/guides.md#get-payment-request-by-id)
{% endstep %}
{% endstepper %}

***

## 🧰 Environments & Base URLs

<table><thead><tr><th width="241">Environment</th><th>Base URL</th></tr></thead><tbody><tr><td>Production (default)</td><td><code>https://public-api.alternativepayments.io</code></td></tr><tr><td>Demo</td><td><code>https://public-api.demo.alternativepayments.io</code></td></tr></tbody></table>

All examples in this guide use production URLs. Switch to the demo when you test. Tokens and requests are isolated per environment.

{% hint style="danger" %}

#### Caution

Tokens issued in one environment do **NOT** work in the other. Generate separate client credentials for demo and production.
{% endhint %}

{% hint style="warning" %}

#### API Versioning

The current stable version is **v1**. Backward‑compatible changes (new fields, new statuses) are rolled out without a version bump. Breaking changes, if ever needed, will ship under `/v2`.
{% endhint %}


---

# 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://docs.alternativepayments.io/getting-started/quick-start.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.
