Hanzo
OpenapiCommerce

Fetch one transfer

A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.

GET /v1/commerce/transfer/{transferid}

Addresshttps://api.hanzo.ai/v1/commerce/transfer/{transferid}
MethodGET
Operationget_commerce_transfer_by_transferid
AuthAuthorization: Bearer $HANZO_API_KEY

A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band. Commerce executes no payout: creating one moves no money, and it marks the referenced payable settled. It carries the payable and payee ids, the amount it settles and the amount actually sent (which may be a different asset), a type of eth, wire or other, the transaction hash or wire reference, when it was paid and who recorded it; amounts are exact decimal strings with an asset, not cents. It is admin-gated because writing one settles money we owe, and nothing enforces uniqueness on the reference — so posting the same transfer twice settles the payable twice. Reads the addressed row from the caller org's own namespaced store. An id that is not there is 404 — and another tenant's id is not there by construction, so it reads exactly like a typo instead of confirming the row exists somewhere else. The token must carry the ADMIN permission; an ordinary access token is refused. The per-kind permission table has no entry for transfer, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.

Request

1 field.

FieldInTypeRequiredDescription
transferidpathstringyes

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 transfer get <transferid>

Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page