Record an order payment or authorization hold
Records a payment fact on an OPEN or COMPLETED order. Create with status AUTHORIZED to model a card preauthorization — a not-to-exceed hold that can be adjusted and later captured for a lower final total. Only COMPLETED payments count toward order tender totals; holds never do. Currency and payment_type are immutable, and payments cannot be deleted.
POST
Authorizations
OAuth 2.0 with opaque bearer tokens. Authorization-code requests require PKCE S256.
Headers
Pin a dated API release (YYYY-MM-DD). Omit for the latest (2026-06-09). Unknown values return 400 unsupported_api_version; the resolved version is echoed back in the X-API-Version response header.
Pattern:
^\d{4}-\d{2}-\d{2}$Example:
"2026-06-09"
Path Parameters
Body
application/json
The body is of type any.
Response
Payment recorded.