# listPayments

Source: <https://telegafirst.com/docs/api-op-listpayments>
Locale: ru
releaseGitSha: ea133cd4ad87fe549ef000b139be145be9bd1717
sourceContentDigest: 9f6e92bba9f145acec5bc7364ede50cbe0e2bd8c1182c22bc2cd6a8e1d351642
Version: 2

# listPayments

`GET /api/v1/payments`

List tenant payments using safe related sequences

## Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

| Поле | Значение |
| - | - |
| security.0.hubApiKey | \[] |
| security.1.hubBearer | \[] |
| securitySchemes.hubApiKey.in | "header" |
| securitySchemes.hubApiKey.name | "X-Api-Key" |
| securitySchemes.hubApiKey.type | "apiKey" |
| securitySchemes.hubBearer.scheme | "bearer" |
| securitySchemes.hubBearer.type | "http" |
| x-required-scopes | \["pull:payments"] |

## Параметры запроса

| Поле | Значение |
| - | - |
| 0.in | "query" |
| 0.name | "cursor" |
| 0.required | false |
| 0.schema | [0.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 1.in | "query" |
| 1.name | "limit" |
| 1.required | false |
| 1.schema | [1.schema](https://telegafirst.com/docs/schema-d5a582c54cf7e16dda7dfbe23f8bd71caba8715bdbf71772e28e43981b674d3e) |
| 2.in | "query" |
| 2.name | "sort" |
| 2.required | false |
| 2.schema | [2.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 3.description | "user,order (one level, comma-separated); absent means no list expansions." |
| 3.in | "query" |
| 3.name | "include" |
| 3.required | false |
| 3.schema | [3.schema](https://telegafirst.com/docs/schema-14f2d0f4c623ae6b25a5a33fc82550ac57637364747d3c6cea9f7e5f470e2b3a) |
| 4.description | "pending,succeeded,failed,canceled,refunded,unknown,expired; scalar or comma-separated list. unknown/expired project to failed." |
| 4.in | "query" |
| 4.name | "status" |
| 4.required | false |
| 4.schema | [4.schema](https://telegafirst.com/docs/schema-c72766445963b04dc2c69b64fe90cc7e94f978d6769aff4ff415f3efd3ea404e) |
| 5.description | "Related User tenant-local positive int4, resolved with client\_id. Scalar, comma list (max 100), or bracket operators gte/lte/gt/lt/eq/neq." |
| 5.in | "query" |
| 5.name | "user\_seq\_num" |
| 5.required | false |
| 5.schema | [5.schema](https://telegafirst.com/docs/schema-6004c347577d8deb76c8e2e471573dd1890fa0e1d0d82134c6c4259b0edc7bb5) |
| 6.description | "Related Order tenant-local positive int4, resolved with client\_id. Scalar, comma list (max 100), or bracket operators gte/lte/gt/lt/eq/neq." |
| 6.in | "query" |
| 6.name | "order\_seq\_num" |
| 6.required | false |
| 6.schema | [6.schema](https://telegafirst.com/docs/schema-9cd0f96a9ed418f66a3913cbee5fa3a124839e9b105ee01a528c11d9b6fba57d) |
| 7.description | "Provider or comma list (max 100); bracket operators are unsupported." |
| 7.in | "query" |
| 7.name | "provider" |
| 7.required | false |
| 7.schema | [7.schema](https://telegafirst.com/docs/schema-e368021833fddbf510d17660d1c8aaa1a8233e24dbda51b0fe2761cbec78df59) |
| 8.description | "Finite numeric amount\_gross or bracket operators gte/lte/gt/lt/eq/neq. Comma lists are unsupported." |
| 8.in | "query" |
| 8.name | "amount" |
| 8.required | false |
| 8.schema | [8.schema](https://telegafirst.com/docs/schema-e71781142606c28e4260b91816ac95d4231f3c57a2e449ef06cd58b789928b08) |
| 9.description | "Date or bracket operators gte/lte/gt/lt/eq/neq. Comma lists are unsupported." |
| 9.in | "query" |
| 9.name | "created\_at" |
| 9.required | false |
| 9.schema | [9.schema](https://telegafirst.com/docs/schema-e6e1502c0603536afda475ba0fcca4a7d19dd829deed27b43c21bf5bec6d68d2) |

## Тело запроса

| Поле | Значение |
| - | - |
| Тело запроса | null |

## Ответы

| Поле | Значение |
| - | - |
| 200.content.application/json.schema | [PaymentListEnvelope](https://telegafirst.com/docs/schema-fa6fadbb379a247e242fc296e544c3cbd9a34806dde9e3a37da19e50ec80ca22) |
| 200.description | "Payment page; decimal amounts remain strings and nested expansions omit private row keys" |
| 200.headers.X-Bot-Username.description | "Active bot public username, when API-key metadata contains it." |
| 200.headers.X-Bot-Username.schema | [200.headers.X-Bot-Username.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 200.headers.X-Client-Slug.description | "Active tenant public slug, when API-key metadata contains it." |
| 200.headers.X-Client-Slug.schema | [200.headers.X-Client-Slug.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 200.headers.X-RateLimit-Limit.description | "Effective rate budget; fallback 120 without a per-key or request decision." |
| 200.headers.X-RateLimit-Limit.schema | [200.headers.X-RateLimit-Limit.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 200.headers.X-RateLimit-Remaining.description | "Nonnegative remaining count or unknown when no rate-limit decision is attached." |
| 200.headers.X-RateLimit-Remaining.schema | [200.headers.X-RateLimit-Remaining.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 200.headers.X-RateLimit-Reset.description | "Rate window reset as a Unix timestamp in seconds." |
| 200.headers.X-RateLimit-Reset.schema | [200.headers.X-RateLimit-Reset.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |

## Ошибки

| Поле | Значение |
| - | - |
| 400.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 400.description | "Invalid limit, include, sequence filter, other filter or cursor; user\_id/order\_id are rejected" |
| 400.x-error-codes | \["INVALID\_REQUEST","INVALID\_FILTER","INVALID\_CURSOR"] |
| 401.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 401.description | "Missing, invalid, revoked or expired API credential" |
| 401.x-error-codes | \["INVALID\_API\_KEY"] |
| 403.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 403.description | "Missing scope, paid plan window, unsupported publishable key or no active business" |
| 403.x-error-codes | \["INSUFFICIENT\_SCOPE","PLAN\_UPGRADE\_REQUIRED","PUBLISHABLE\_KEY\_NOT\_ALLOWED","NO\_ACTIVE\_BOT"] |
| 413.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 413.description | "Per-tool request size or item count cap exceeded" |
| 413.x-error-codes | \["PAYLOAD\_TOO\_LARGE","ITEM\_COUNT\_EXCEEDED"] |
| 429.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 429.description | "Resource policy rate limit exceeded or subsystem unavailable" |
| 429.headers.Retry-After.description | "Retry delay in seconds when provided by the resource policy decision" |
| 429.headers.Retry-After.schema | [429.headers.Retry-After.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 429.x-error-codes | \["RATE\_LIMIT\_EXCEEDED","RATE\_LIMIT\_UNAVAILABLE"] |

## Дополнительные условия

| Поле | Значение |
| - | - |
| description | "X-Api-Key or Bearer tgf\_\* only; a surface JWT is not accepted. Requires every declared scope. User/Order filters and expansions are tenant-scoped. limit defaults to 50 (1..200). Encrypted keyset cursor expires after 900 seconds, bound to tenant/resource/effective filters. sort is accepted but ordering remains created\_at desc/id desc. No ETag conditional response or Idempotency-Key requirement." |
| operationId | "listPayments" |
| summary | "List tenant payments using safe related sequences" |
| tags | \["payments"] |