> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tiankii.com/_mcp/server.

# Overview

## Payment Requests — Base: `/v1/payment-requests`

A **payment request** is the aggregate the merchant uses to **collect payment**. Every payment request has a `type` discriminator that shapes it:

* **`PAYMENT_LINK`** → *Payment Links*: a **hosted, shareable payment page**, reusable, that can receive one or many payments.

* **`INVOICE`** → *Invoices*: a **bill issued to a specific customer** (items, quantity, taxes, due date, PO, memo) that generates a *checkout invoice* when the customer pays it.

* **`SUBSCRIPTION`** → type reserved for recurring charges.

All types **share** the same query and lifecycle operations on `/payment-requests` (list/filter, get, pay, activate, deactivate, archive, complete, delete, coupons). **Creation and update** are type-specific and live in each subfolder.

Filter by type with `GET /payment-requests?type=PAYMENT_LINK|INVOICE|SUBSCRIPTION`.

### Subfolders

* **Payment Links** (`PAYMENT_LINK`) — create/update payment links.

* **Invoices** (`INVOICE`) — create/update/send invoices and download their PDF.

* **General operations** — type-agnostic operations (lifecycle + query).

> ⚠️ **Don't confuse them**: an **invoice** (payment request of type `INVOICE`, here) is the *bill* that is issued. A **checkout invoice** (the **Checkout Invoice** folder, `/v1/invoice`) is the Lightning/on-chain *charge* generated when someone pays.

Scopes: `Merchant.payment_link.{read,create,update,delete}` (all types use the `payment_link` scope).

## Docs

- [Overview](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/payment-links.md)
- [Overview](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/invoices.md)
- [Overview](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations.md)

## API Docs

- Payment Links [Create payment link](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/payment-links/create.md)
- Payment Links [Update payment link](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/payment-links/update.md)
- Invoices [Create invoice](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/invoices/create.md)
- Invoices [Update invoice](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/invoices/update.md)
- Invoices [Send invoice by email](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/invoices/send.md)
- Invoices [Download invoice PDF](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/invoices/download-pdf.md)
- General Operations [List payment requests](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/list.md)
- General Operations [List available apps](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/list-available-apps.md)
- General Operations [Get associated app](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/get-app.md)
- General Operations [List coupons](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/list-coupons.md)
- General Operations [Activate payment request](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/activate.md)
- General Operations [Deactivate payment request](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/deactivate.md)
- General Operations [Archive payment request](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/archive.md)
- General Operations [Complete payment request](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/complete.md)
- General Operations [Delete payment request](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/delete.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/openapi.json)
- [OpenAPI YAML](https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/openapi.yaml)