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

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

configurePaymentCredentials

Обновлено

POST /api/v1/tools/payments

Configure one credentialed payment provider

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

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["payments:config"]

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

ПолеЗначение
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema

Тело запроса

ПолеЗначение
content.application/json.schemaPaymentCredentialsConfigureRequest
requiredtrue

Ответы

ПолеЗначение
201.content.application/json.schemaPaymentProviderView
201.description"Saved provider availability and display currency, with no credential values"
201.headers.X-Bot-Username.description"Active tenant public bot username, when available"
201.headers.X-Bot-Username.schema201.headers.X-Bot-Username.schema
201.headers.X-Client-Slug.description"Active tenant public slug, when available"
201.headers.X-Client-Slug.schema201.headers.X-Client-Slug.schema
201.headers.X-RateLimit-Limit.description"Computed request budget"
201.headers.X-RateLimit-Limit.schema201.headers.X-RateLimit-Limit.schema
201.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
201.headers.X-RateLimit-Remaining.schema201.headers.X-RateLimit-Remaining.schema
201.headers.X-RateLimit-Reset.description"Budget reset Unix timestamp"
201.headers.X-RateLimit-Reset.schema201.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Strict body validation failed, or a POST body has no Idempotency-Key"
401.content.application/problem+json.schemaProblemDetails
401.description"Missing, invalid or conflicting API-key transports; a surface-session JWT is not an alternative"
403.content.application/problem+json.schemaProblemDetails
403.description"Owner-only payments:config scope or effective credential access refused"
409.content.application/problem+json.schemaProblemDetails
409.description"The idempotent command is already processing"
413.content.application/problem+json.schemaProblemDetails
413.description"Per-tool payload or item-count cap exceeded"
422.content.application/problem+json.schemaProblemDetails
422.description"Idempotency-Key reused with a different body, or provider enablement rejected by fiscal/credential prerequisites"
429.content.application/problem+json.schemaProblemDetails
429.description"Per-tool rate limit exceeded or unavailable; fail closed"
429.headers.Retry-After.description"Seconds before retry when supplied by the limiter"
429.headers.Retry-After.schema429.headers.Retry-After.schema

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

ПолеЗначение
description"Owner-only. Strict snake_case credential union has eight providers; Stars uses enable instead. enabled defaults to true in the shared writer, not in the request validator. Secrets are accepted as input and never returned. POST body requires Idempotency-Key; tenant/credential/handler replay preserves status and body for 86400 seconds."
operationId"configurePaymentCredentials"
summary"Configure one credentialed payment provider"
tags["payments-config"]