Create gateway

Takes a signed USDC payment from the caller's Circle Gateway balance to the treasury, and answers what became of it.

POST /v1/billing/crypto/gateway

Addresshttps://api.hanzo.ai/v1/billing/crypto/gateway
MethodPOST
Operationpost_billing_crypto_gateway
AuthAuthorization: Bearer $HANZO_API_KEY

Takes a signed USDC payment from the caller's Circle Gateway balance to the treasury, and answers what became of it.

accepted: Circle Gateway LOCKED the USDC and the caller is credited — or, once the caller holds $1,000 of credit Gateway has not confirmed, credited when Gateway confirms this payment (deferred). pending: the outcome is not known yet; read it back or present the same payment again — it resolves to one credit either way. A refusal is 4xx with Gateway's reason (insufficient_balance, invalid_signature, …) or ours (nonce_not_issued, recipient_mismatch, amount_below_minimum, …); 503 means the rail is shut.

Who is credited is the caller, never a body value: the payer is resolved server-side, and the payment's own nonce must be the one issued to it.

A named handler, not a closure, so zipdoc can lift this prose into the registry.

Request

10 fields, body application/json (required).

FieldInTypeRequiredDescription
authorizationbodybilling.GatewayAuthorization—
authorization.frombodystring—
authorization.noncebodystring—
authorization.tobodystring—
authorization.validAfterbodystring—
authorization.validBeforebodystring—
authorization.valuebodystring—
networkbodystring—Network is the CAIP-2 network the payment was signed for, one of the terms' accepts, e.g. "eip155:8453".
saltbodystring—Salt is the salt the terms issued with the nonce.
signaturebodystring—Signature is the 65-byte EIP-712 signature, 0x hex.

Response

StatusBodyMeaning
200billing.GatewayPaymentok
defaultproblem-detailsrefused

200 body — 13 fields.

FieldInTypeAlwaysDescription
amountCentsbodyinteger (int64)—
createdAtbodystring—
creditedbodyboolean—
deferredbodyboolean—
frombodystring—
idbodystring—
networkbodystring—
paymentbodystring—
reasonbodystring—
statusbodystring—
txHashbodystring—
updatedAtbodystring—
valuebodystring—

Failure carries the platform error shape — see Errors.

Examples

hanzo billing crypto gateway create
import { Configuration, BillingApi } from 'hanzoai';

const api = new BillingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postBillingCryptoGateway({ authorization: {"from":"<from>","nonce":"<nonce>","to":"<to>","validAfter":"<validAfter>"}, network: "<network>" });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BillingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BillingApi(client).post_billing_crypto_gateway(authorization={"from":"<from>","nonce":"<nonce>","to":"<to>","validAfter":"<validAfter>"}, network="<network>")
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.BillingAPI.PostBillingCryptoGateway(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, billing_api};

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

let result = billing_api::post_billing_crypto_gateway(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.BillingApi;

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

var result = new BillingApi(client).postBillingCryptoGateway();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X POST https://api.hanzo.ai/v1/billing/crypto/gateway \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "authorization": {
         "from": "<from>",
         "nonce": "<nonce>",
         "to": "<to>",
         "validAfter": "<validAfter>"
       },
       "network": "<network>"
     }'

MCP reaches billing through the billing tool, which names its 45 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_billing_accounts"
         }
       }
     }'

Billing API · All Hanzo APIs · Interactive reference

Was this page useful?
Broken link or missing step? Drop it in #docs on Discord or open a PR.