К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-listpayments.mdиндекс документации — /llms.txt

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.requiredfalse
0.schema0.schema
1.in"query"
1.name"limit"
1.requiredfalse
1.schema1.schema
2.in"query"
2.name"sort"
2.requiredfalse
2.schema2.schema
3.description"user,order (one level, comma-separated); absent means no list expansions."
3.in"query"
3.name"include"
3.requiredfalse
3.schema3.schema
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.requiredfalse
4.schema4.schema
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.requiredfalse
5.schema5.schema
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.requiredfalse
6.schema6.schema
7.description"Provider or comma list (max 100); bracket operators are unsupported."
7.in"query"
7.name"provider"
7.requiredfalse
7.schema7.schema
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.requiredfalse
8.schema8.schema
9.description"Date or bracket operators gte/lte/gt/lt/eq/neq. Comma lists are unsupported."
9.in"query"
9.name"created_at"
9.requiredfalse
9.schema9.schema

Тело запроса

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

Ответы

ПолеЗначение
200.content.application/json.schemaPaymentListEnvelope
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.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Active tenant public slug, when API-key metadata contains it."
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Effective rate budget; fallback 120 without a per-key or request decision."
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.description"Nonnegative remaining count or unknown when no rate-limit decision is attached."
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.description"Rate window reset as a Unix timestamp in seconds."
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
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.schemaProblemDetails
401.description"Missing, invalid, revoked or expired API credential"
401.x-error-codes["INVALID_API_KEY"]
403.content.application/problem+json.schemaProblemDetails
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.schemaProblemDetails
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.schemaProblemDetails
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.schema429.headers.Retry-After.schema
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"]