Get runtime payments resource

GET/v1/servers/{serverId}/runtime/payments

Return the payments resource bound to this resource using runtime authorization.

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
NameLocationTypeRequiredDescription
serverIdpathstringYesResource ID
Query parameters
None.

Body schema

This endpoint does not require a request body.

None.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Runtime payments resourceapplication/json
FieldTypeRequiredDescription
serverIdstringNoResource ID.
paymentsServerIdstringNo
paymentsobjectNo
payments.idstringNoUnique identifier.
payments.namestringNoHuman-readable name.
payments.kindpaymentsNo
payments.statusstringNoCurrent lifecycle status.
payments.providerstringNo
payments.modetest | liveNo
payments.stripeAccountIdstringNo
payments.onboardingStatusnot_started | pending | completeNo
payments.chargesEnabledbooleanNo
payments.payoutsEnabledbooleanNo
payments.currencystringNo
payments.totalEarnedCentsintegerNo
payments.totalPaymentCountintegerNo
payments.updatedAtstringNoISO 8601 timestamp.
Get runtime payments resource
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow