Create capture — POST /v1/commerce/store/{storeid}/capture/{orderid}

Settles the order named in the path — the second half of the two-step flow — and answers the updated order with a Location header.

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

Commerce → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/commerce/store/{storeid}/capture/{orderid}`
Method	`POST`
Operation	`post_commerce_store_by_storeid_capture_by_orderid`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Settles the order named in the path — the second half of the two-step flow — and answers the updated order with a Location header. Dispatch follows the order's STORED payment type, and a successful capture is the moment the rest of the system learns about the sale: order and payment rows are updated, coupon redemptions, referral, cart and stats are written, the confirmation email goes out, and the paid and completed events are emitted. A capture failure releases the order's inventory reservations and answers 400, so a failed settlement never leaves items held.

Request

2 fields.

Field	In	Type	Required	Description
`storeid`	path	string	yes
`orderid`	path	string	yes

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

CLI

SDK

HTTP

MCP

hanzo commerce store capture add <storeid> <orderid>

.ts

.py

.go

.rs

.java

import { Configuration, CommerceApi } from 'hanzoai';

const api = new CommerceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postCommerceStoreByStoreidCaptureByOrderid({ storeid: 'storeid', orderid: 'orderid' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CommerceApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CommerceApi(client).post_commerce_store_by_storeid_capture_by_orderid(storeid='storeid', orderid='orderid')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.CommerceAPI.PostCommerceStoreByStoreidCaptureByOrderid(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, commerce_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = commerce_api::post_commerce_store_by_storeid_capture_by_orderid(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CommerceApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new CommerceApi(client).postCommerceStoreByStoreidCaptureByOrderid();

curl -X POST https://api.hanzo.ai/v1/commerce/store/<storeid>/capture/<orderid> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches commerce through the commerce tool, which names its 5 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_commerce_health"
         }
       }
     }'

Commerce API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate authorize — POST /v1/commerce/store/{storeid}/authorize NextCreate charge — POST /v1/commerce/store/{storeid}/charge