A valid request URL is required to generate request examples{
"id": "<string>",
"requestId": "<string>",
"status": "pending",
"currency": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"principalMicros": "<string>",
"taxMicros": "<string>",
"feeMicros": "<string>",
"totalMicros": "<string>",
"paymentUrl": "<string>",
"closeReason": "abandoned",
"returnQuoteId": "<string>",
"returnQuantity": 1,
"quoteId": "<string>",
"termsVersion": "<string>",
"start": {
"id": "<string>",
"state": "waiting_payment",
"model": "<string>",
"region": "<string>",
"identityId": "<string>",
"quantity": 500,
"rateMicrosPerMinute": "<string>",
"startMicrosPerPhone": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"topupId": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"orderId": "<string>",
"reason": "sold_out"
},
"taxBehavior": "exclusive"
}{
"error": {
"code": "rate_limited",
"message": "<string>"
}
}/v1/minute/topups/:id
Private prepaid minute contract. Organization admin first-party session required. Stable request ID binds original operation. Pending or unknown payments do not grant funds.
Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.
A valid request URL is required to generate request examples{
"id": "<string>",
"requestId": "<string>",
"status": "pending",
"currency": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"principalMicros": "<string>",
"taxMicros": "<string>",
"feeMicros": "<string>",
"totalMicros": "<string>",
"paymentUrl": "<string>",
"closeReason": "abandoned",
"returnQuoteId": "<string>",
"returnQuantity": 1,
"quoteId": "<string>",
"termsVersion": "<string>",
"start": {
"id": "<string>",
"state": "waiting_payment",
"model": "<string>",
"region": "<string>",
"identityId": "<string>",
"quantity": 500,
"rateMicrosPerMinute": "<string>",
"startMicrosPerPhone": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"topupId": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"orderId": "<string>",
"reason": "sold_out"
},
"taxBehavior": "exclusive"
}{
"error": {
"code": "rate_limited",
"message": "<string>"
}
}Authorizations
The control surface credential. Send Authorization: Bearer <token>.
Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning pbk_ or puk_ is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.
Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.
Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from tools/list rather than refused mid gesture.
Response
Authoritative durable projection.
- Option 1
- Option 2
- Option 3
Only with status failed: the Checkout was closed unpaid, not declined. abandoned = the customer came back without paying; replaced = a newer top-up was started; expired = Checkout timed out with no payment attempt. No failure notice is sent for these.
abandoned, replaced, expired