Get gateway

Reads one of the caller's own USDC top-ups back: pending, accepted (credited or deferred), settled, failed or refused.

GET /v1/billing/crypto/gateway/{id}

Billing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/billing/crypto/gateway/{id}`
Method	`GET`
Operation	`get_billing_crypto_gateway_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reads one of the caller's own USDC top-ups back: pending, accepted (credited or deferred), settled, failed or refused.

A payment belonging to another payer answers 404, exactly as an id that names nothing, so a guessed id cannot confirm somebody else's payment exists.

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

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the top-up's id, from the path.

Response

Status	Body	Meaning
`200`	billing.GatewayPayment	ok
`default`	problem-details	refused

200 body — 13 fields.

Field	In	Type	Always
`amountCents`	body	integer (int64)	—
`createdAt`	body	string	—
`credited`	body	boolean	—
`deferred`	body	boolean	—
`from`	body	string	—
`id`	body	string	—
`network`	body	string	—
`payment`	body	string	—
`reason`	body	string	—
`status`	body	string	—
`txHash`	body	string	—
`updatedAt`	body	string	—
`value`	body	string	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo billing crypto gateway get <id>

.ts

.py

.go

.rs

.java

import { Configuration, BillingApi } from 'hanzoai';

const api = new BillingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBillingCryptoGatewayById({ id: 'id' });

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).get_billing_crypto_gateway_by_id(id='id')

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

resp, _, err := client.BillingAPI.GetBillingCryptoGatewayById(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::get_billing_crypto_gateway_by_id(&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).getBillingCryptoGatewayById();

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 https://api.hanzo.ai/v1/billing/crypto/gateway/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool billing, op get_billing_crypto_gateway_by_id — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "billing",
         "arguments": {
           "op": "get_billing_crypto_gateway_by_id",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'

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.

PreviousGet deposit NextList gateway