Hanzo
OpenapiBilling

Answers the org's outbound payouts, newest first — amount, destination, status,…

Answers the org's outbound payouts, newest first — amount, destination, status, and the failure reason where one applies.

GET /v1/billing/payouts

Addresshttps://api.hanzo.ai/v1/billing/payouts
MethodGET
Operationget_billing_payouts
AuthAuthorization: Bearer $HANZO_API_KEY

Answers the org's outbound payouts, newest first — amount, destination, status, and the failure reason where one applies.

A payout is ORG-scoped rather than subject-scoped, so there is nothing to pin beyond the tenant the caller already is, and no query can widen it.

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

Request

GET /v1/billing/payouts takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200Payout[]ok

200 body — 13 fields.

FieldInTypeAlwaysDescription
[].amountbodyinteger
[].arrivalDatebodystring
[].createdbodystring
[].currencybodystring
[].descriptionbodystring
[].destinationIdbodystring
[].destinationTypebodystring
[].failureCodebodystring
[].failureMessagebodystring
[].idbodystring
[].metadatabodyany
[].providerRefbodystring
[].statusbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo billing payouts

Billing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page