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

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

getPayment

Обновлено

GET /api/v1/payments/{seq_id}

Read a tenant payment by its local sequence

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

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"path"
0.name"seq_id"
0.requiredtrue
0.schema0.schema
1.description"user,order (one level, comma-separated); default both"
1.in"query"
1.name"include"
1.requiredfalse
1.schema1.schema

Тело запроса

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

Ответы

ПолеЗначение
200.content.application/json.schemaPaymentDetail
200.description"Payment with safe User/Order projections"
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 positive-int4 address or include"
400.x-error-codes["INVALID_REQUEST"]
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"]
404.content.application/problem+json.schemaProblemDetails
404.description"Payment sequence was not found in the selected tenant"
404.x-error-codes["NOT_FOUND"]
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"Resolves (client_id, seq_id), never a platform PK or pay_* prefix. X-Api-Key or Bearer tgf_* only; a surface JWT is not accepted. include accepts user,order at one level. Omitted or empty include expands both by default; foreign-tenant relations and their qualified sequence fields are omitted. No ETag conditional response or Idempotency-Key requirement."
operationId"getPayment"
summary"Read a tenant payment by its local sequence"
tags["payments"]