Create confirm — POST /v1/commerce/store/{storeid}/paypal/confirm/{payKey}

Intended to mark every payment carrying the given pay key as paid and flip the order to paid, it cannot do that from this address and does not pretend to: the shared checkout handler resolves its order from an ORDER ID path parameter that this route does not carry, so it always works against a fresh untyped order and the confirm dispatch refuses it with 400 before the pay key is ever queried.

POST /v1/commerce/store/{storeid}/paypal/confirm/{payKey}

Commerce → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/commerce/store/{storeid}/paypal/confirm/{payKey}`
Method	`POST`
Operation	`post_commerce_store_by_storeid_paypal_confirm_by_paykey`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Intended to mark every payment carrying the given pay key as paid and flip the order to paid, it cannot do that from this address and does not pretend to: the shared checkout handler resolves its order from an ORDER ID path parameter that this route does not carry, so it always works against a fresh untyped order and the confirm dispatch refuses it with 400 before the pay key is ever queried. The token gate, the namespace and the store lookup all run ahead of that, so a missing token is still 401 and an unloadable store still 500. Drive a PayPal return through 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

CLI

SDK

HTTP

MCP

hanzo commerce store paypal confirm add <storeid> <payKey>

.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.postCommerceStoreByStoreidPaypalConfirmByPaykey({ 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_confirm_by_paykey(storeid='storeid', pay_key='payKey')

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

resp, _, err := client.CommerceAPI.PostCommerceStoreByStoreidPaypalConfirmByPaykey(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_paypal_confirm_by_paykey(&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).postCommerceStoreByStoreidPaypalConfirmByPaykey();

curl -X POST https://api.hanzo.ai/v1/commerce/store/<storeid>/paypal/confirm/<payKey> \
  -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 cancel — POST /v1/commerce/store/{storeid}/paypal/cancel/{payKey}NextCreate pay — POST /v1/commerce/store/{storeid}/paypal/pay