Hanzo
OpenapiCommerce

Capture a previously authorized order and settle it — the checkout spelling

Settles the authorized order named in the path and answers the updated order with a Location header, running the same handler as the unprefixed capture…

POST /v1/commerce/store/{storeid}/checkout/capture/{orderid}

Addresshttps://api.hanzo.ai/v1/commerce/store/{storeid}/checkout/capture/{orderid}
MethodPOST
Operationpost_commerce_store_by_storeid_checkout_capture_by_orderid
AuthAuthorization: Bearer $HANZO_API_KEY

Settles the authorized order named in the path and answers the updated order with a Location header, running the same handler as the unprefixed capture address. Dispatch follows the order's stored payment type. Success is what triggers the downstream work — order and payment updates, redemptions, referral, cart and stats, the confirmation email, and the paid and completed events — while a failure releases the order's inventory reservations and answers 400.

Request

2 fields.

FieldInTypeRequiredDescription
storeidpathstringyes
orderidpathstringyes

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page