Hanzo
OpenapiCommerce

Read one settled payment by its id

Reads one settled payment out of the caller's org ledger.

GET /v1/commerce/payments/{id}

Addresshttps://api.hanzo.ai/v1/commerce/payments/{id}
MethodGET
OperationgetPayment
AuthAuthorization: Bearer $HANZO_API_KEY

Reads one settled payment out of the caller's org ledger.

The org scopes the read by construction — the ledger is namespaced to it — so an id belonging to another tenant is simply not found rather than found and then filtered. A ledger row that is not a payment is likewise not found, so this cannot be used to walk the org's usage debits.

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

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the ledger transaction id a payment returned.

Response

StatusBodyMeaning
200PaymentRecordok

200 body — 8 fields.

FieldInTypeAlwaysDescription
amountCentsbodyintegerAmountCents is the credited amount in whole cents.
createdAtbodystringCreatedAt is when the credit was written, RFC3339.
currencybodystringCurrency is the ISO 4217 code.
idbodystringID is the ledger transaction id.
notesbodystringNotes is the ledger memo, carrying the processor and its reference.
statusbodystringStatus is the payment's state.
subjectbodystringSubject is the billing key this payment credited.
testbodybooleanTest reports whether this was a sandbox charge (test balance) or live money.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page