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

# List payment requests

GET https://api.md.tiankii.com/v1/payment-requests

## List payment requests

Returns a paginated list of **payment requests** owned by the store resolved from the API key (or the store scoped via `x-application-account-id`). Payment requests are the umbrella aggregate over payment links, invoices and subscriptions; the `type` field discriminates them and shapes each record.

### Authentication

Send the merchant API key in the `x-api-key` header (alias `x-account-api-key`). The key must carry the scope `Merchant.payment_link.read`. Optionally scope the key to a specific store/account with the `x-application-account-id` header (alias `x-account-id`) or the `application_account_id` / `account_id` query param.

### Query parameters

* **Pagination**: `page` (default 1), `per_page` (default 10).
* **Date range**: `start_at` / `end_at` (ISO date-time). They are validated as a pair — if one is present the other is required. Filters by the `Created` date.
* **Status**: `Status` — numeric payment request status (0 = PENDING, 1 = COMPLETED, 2 = EXPIRED, 3 = ACTIVE, 4 = DEACTIVATED).
* **Type**: `type` — one of `PAYMENT_LINK`, `INVOICE`, `SUBSCRIPTION`.
* **Sorting**: `sort` (Prisma orderBy over allowed fields `Status`, `Created`, `Archived`) or `sorter` (a JSON string, e.g. `{"Created":"desc"}`).

### Response

A paginated envelope with `meta` (pagination info), `records` (array of payment requests shaped by type) and a legacy `_metadata` block. There is **no request body**.

***

**Notas:** Handler: paymentRequestsService.findMany. Records are shaped by presenter per type (PaymentLinkResponseDto or BillingInvoiceResponseDto); only whitelisted data-blob fields are returned. Response uses createPaginatedResponse (meta + records + legacy \_metadata).

Reference: https://docs.tiankii.com/api-reference/tiankii-api-api-key/payment-requests/general-operations/list

## Authentication

- `x-api-key` header (required)

## Request

### Query parameters

- `page` (integer, optional, default: 1) — Page number to return.
- `per_page` (integer, optional, default: 10) — Number of records per page.
- `start_at` (datetime, optional) — Start of the `Created` date range (ISO 8601). Must be sent together with `end_at` — supplying only one is a validation error.
- `end_at` (datetime, optional) — End of the `Created` date range (ISO 8601). Must be sent together with `start_at`.
- `Status` (integer, optional) — Filter by payment request status: `0` PENDING, `1` COMPLETED, `2` EXPIRED, `3` ACTIVE, `4` DEACTIVATED.
- `CustomerId` (string, optional) — Return only payment requests issued to this customer.
- `type` (enum, optional) — Filter by payment request type.
  - Allowed values: `PAYMENT_LINK`, `INVOICE`, `SUBSCRIPTION`
- `sort` (string, optional) — Sort by one or more fields, comma-separated. **Allowed fields:** `Status`, `Created`, `Archived` **Formats:** `field` (ascending by default), `+field`, `-field`, `field:asc`, `field:desc` (`|` also works as the separator).
- `sorter` (string, optional) — Alternative to `sort`: a JSON string mapping a field to a direction (`asc` / `desc`). **Allowed fields:** `Status`, `Archived`, `Created`

### Headers

- `x-application-account-id` (string, optional) — Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the `x-account-id` header, or the `application_account_id` / `account_id` query parameter.

## Examples

**SDK Code**

```python
import requests

url = "https://api.md.tiankii.com/v1/payment-requests"

querystring = {"CustomerId":"9c0a1b2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d","end_at":"2026-01-31T23:59:59Z","sort":"-Created","sorter":"{\"Created\":\"desc\"}","start_at":"2026-01-01T00:00:00Z"}

headers = {
    "x-application-account-id": "acct_3f9a21c7",
    "x-api-key": "<apiKey>"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.md.tiankii.com/v1/payment-requests?CustomerId=9c0a1b2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d&end_at=2026-01-31T23%3A59%3A59Z&sort=-Created&sorter=%7B%22Created%22%3A%22desc%22%7D&start_at=2026-01-01T00%3A00%3A00Z';
const options = {
  method: 'GET',
  headers: {'x-application-account-id': 'acct_3f9a21c7', 'x-api-key': '<apiKey>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.md.tiankii.com/v1/payment-requests?CustomerId=9c0a1b2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d&end_at=2026-01-31T23%3A59%3A59Z&sort=-Created&sorter=%7B%22Created%22%3A%22desc%22%7D&start_at=2026-01-01T00%3A00%3A00Z"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-application-account-id", "acct_3f9a21c7")
	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.md.tiankii.com/v1/payment-requests?CustomerId=9c0a1b2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d&end_at=2026-01-31T23%3A59%3A59Z&sort=-Created&sorter=%7B%22Created%22%3A%22desc%22%7D&start_at=2026-01-01T00%3A00%3A00Z")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-application-account-id"] = 'acct_3f9a21c7'
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.md.tiankii.com/v1/payment-requests?CustomerId=9c0a1b2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d&end_at=2026-01-31T23%3A59%3A59Z&sort=-Created&sorter=%7B%22Created%22%3A%22desc%22%7D&start_at=2026-01-01T00%3A00%3A00Z")
  .header("x-application-account-id", "acct_3f9a21c7")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.md.tiankii.com/v1/payment-requests?CustomerId=9c0a1b2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d&end_at=2026-01-31T23%3A59%3A59Z&sort=-Created&sorter=%7B%22Created%22%3A%22desc%22%7D&start_at=2026-01-01T00%3A00%3A00Z', [
  'headers' => [
    'x-api-key' => '<apiKey>',
    'x-application-account-id' => 'acct_3f9a21c7',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.md.tiankii.com/v1/payment-requests?CustomerId=9c0a1b2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d&end_at=2026-01-31T23%3A59%3A59Z&sort=-Created&sorter=%7B%22Created%22%3A%22desc%22%7D&start_at=2026-01-01T00%3A00%3A00Z");
var request = new RestRequest(Method.GET);
request.AddHeader("x-application-account-id", "acct_3f9a21c7");
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-application-account-id": "acct_3f9a21c7",
  "x-api-key": "<apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.md.tiankii.com/v1/payment-requests?CustomerId=9c0a1b2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d&end_at=2026-01-31T23%3A59%3A59Z&sort=-Created&sorter=%7B%22Created%22%3A%22desc%22%7D&start_at=2026-01-01T00%3A00%3A00Z")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```