cdnca

API reference

/v1/admin/recharge-payment-runtime-status

1 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
GET/v1/admin/recharge-payment-runtime-statusRead non-secret recharge payment runtime statusSession

Contract file：api/control-recharge-payment-runtime-status.openapi.yaml

Operation details

GET /v1/admin/recharge-payment-runtime-status

Read non-secret recharge payment runtime status

operationId
getRechargePaymentRuntimeStatus
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

Returns provider configuration/readiness state without credentials or endpoint details.

Responses

getRechargePaymentRuntimeStatus Responses
StatusDescription
200Runtime status

Fields：schema: string state: string: disabled / unavailable / degraded / ready enabled: boolean ready: boolean alipay: RechargePaymentProviderStatus wechat: RechargePaymentProviderStatus bank_transfer: RechargePaymentProviderStatus

401Administrator session required
403Platform system configuration read permission required

What to do on failure

  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.

↑ Back to list