Create cancel
Intended to void the payments carrying the given pay key, stamp them cancelled and cancel the order, it never reaches that work: the shared checkout…
POST /v1/commerce/store/{storeid}/paypal/cancel/{payKey}
| Address | https://api.hanzo.ai/v1/commerce/store/{storeid}/paypal/cancel/{payKey} |
| Method | POST |
| Operation | post_commerce_store_by_storeid_paypal_cancel_by_paykey |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Intended to void the payments carrying the given pay key, stamp them cancelled and cancel the order, it never reaches that work: the shared checkout handler reads its order from an ORDER ID path parameter this route does not carry, leaving an untyped order that the cancel dispatch refuses with 400 before the pay key lookup runs. Authentication, namespacing and store resolution happen ahead of the refusal, so a missing token is 401 and an unloadable store 500. Cancelling a real PayPal authorization needs an address that carries the order id.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
storeid | path | string | yes | |
payKey | 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
hanzo commerce store paypal cancel add <storeid> <payKey>import { Configuration, CommerceApi } from 'hanzoai';
const api = new CommerceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postCommerceStoreByStoreidPaypalCancelByPaykey({ storeid: 'storeid', payKey: 'payKey' });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_paypal_cancel_by_paykey(storeid='storeid', pay_key='payKey')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CommerceAPI.PostCommerceStoreByStoreidPaypalCancelByPaykey(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_paypal_cancel_by_paykey(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CommerceApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new CommerceApi(client).postCommerceStoreByStoreidPaypalCancelByPaykey();curl -X POST https://api.hanzo.ai/v1/commerce/store/<storeid>/paypal/cancel/<payKey> \
-H "Authorization: Bearer $HANZO_API_KEY"MCP reaches commerce through the commerce tool, which names its 215 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": "list___commerce_deposits"
}
}
}'How is this guide?