post
https://connect.agendapro.com/v3/carts//payment_requests
Creates an online payment request for the cart and returns a checkout URL
in params.checkout_url. Share that URL with the end customer to collect
the payment.
Important Notes
- Requires
carts:writescope. - Online payments must be enabled for the company; otherwise the request fails.
- The payment channel is always
online; it cannot be selected through the public API. - Booking reservation errors proxied from platform-sales use legacy single-key codes (e.g.
company_payments_disabled,invalid_start_time,booking_already_sold), not the{error, detail}shape. - The payment request always covers the full cart total.
- When the cart contains service items with on-demand booking instances, the bookings are created and reserved at this point, and
params.expires_atis set (about 15 minutes): if the payment is not completed by then, the payment request expires and the reserved bookings are released automatically. - Creating a new payment request on a cart cancels any previous
pendingone.
Errors Dictionary
| Status | Error | Detail | Description |
|---|---|---|---|
| 401 | unauthorized | invalid_api_key | Missing or invalid Bearer token. |
| 401 | unauthorized | api_config_inactive | API access is inactive for this company. |
| 403 | forbidden | scope_denied | API key lacks carts:write scope. |
| 404 | cart_not_found | Cart not found for this company. | |
| 422 | company_payments_disabled | Online payments are not enabled for the company or the cart items are not payable online. | |
| 429 | rate_limited | burst_limit_exceeded | Per-minute request limit exceeded. |
| 429 | rate_limited | daily_quota_exceeded | Daily request quota exceeded. |
| 502 | upstream_unavailable | The upstream service is unavailable. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
