Zero Hash Payouts API is one of 31 APIs that Zero Hash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
2 operations
across 1 path,
and defines 27 schemas.
It is described by OpenAPI 3.2.0, at version 1.7.0.
Requests are made against a single base URL, https://api.cert.zerohash.com.
2 operations1 paths27 schemas1 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
1.7.0
Base URL
https://api.zerohash.com
Authentication
API Key, API Key
Resource Areas
1
Authentication & Security 2
Zero Hash Payouts API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-SCX-API-KEY (apiKey).
An API key is passed in the header as X-SCX-PASSPHRASE (apiPassphrase).
By default, every request must be authenticated.
apiKey — Your API public key. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for how to obtain keys.
apiPassphrase — The passphrase associated with your API key, set when the key was created.
Paths & Operations 2
Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Payouts 2
Crypto payouts
GET
/payouts
Retrieve payout state
4 params→ 200400403404500503
POST
/payouts
Submit or validate a payout
3 paramsbody→ 200202400403404422500503
Schemas 27
The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are BeneficiaryIndividualInfo (20 properties), PayorIndividualInfo (19 properties), PayorEntityInfo (18 properties), BeneficiaryEntityInfo (17 properties). Each schema is shown below with its type and property counts.
Code400
object
Request was rejected by validation or a downstream service. errors is an array of human-readable messages; each entry describes a single validation failure or…
1 property1 required
PayorEntityInfo
object
18 properties10 required
PayoutResourcePaymentDetails
object
On-chain and zerohash references produced during payment execution. Populated progressively as the payment transitions through posted and settled.
5 properties
Payor
object
Top-level payor — the participant directly debited for the payout. Must be pre-onboarded via POST /participants/entity/new and referenced here by participantco…
2 properties1 required
BeneficiaryEntityInfo
object
17 properties10 required
PayoutResources
object
Lifecycle snapshot of the payout's downstream resources. Each sub-object is null until the corresponding resource is created. Full PII (beneficiary natural-per…
3 properties
PayorBlock
object
Nested payor block representing the upstream originator — the Ultimate Payor (e.g., the merchant's customer). Exactly one of participantcode (references an exi…
PayorIndividualInfo
object
19 properties13 required
BeneficiaryInfo
object
Exactly one of individual or entity is required. Provide individual for natural-person beneficiaries and entity for legal entities (corporations, LLCs, etc.).
PayoutResourcePayor
object
Lifecycle view of the payor chain. Top level carries participantcode (the onboarded merchant); the nested payor (if present) carries the upstream originator's…
2 properties
BeneficiaryIndividualInfo
object
Beneficiary natural-person data.
20 properties8 required
PayoutResourceExternalAccount
object
External account lifecycle + non-PII details. cryptoaddress, accountnickname, and destinationtag are returned on GET but NOT on webhooks.
6 properties
Code500
object
An unexpected error occurred on the server. The request can be retried after a short delay, but the same inputs may reproduce the error.
1 property1 required
PayoutResourcePayment
object
Payment lifecycle + execution details.
12 properties
ExternalAccountInfo
object
Crypto external account belonging to the beneficiary.
6 properties3 required
PayoutMetadata
object
Caller-supplied free-form key-value pairs attached to the payout, supplied on the POST /payouts request body. Write-only: metadata is NOT returned on the POST…
PayorInfo
object
Exactly one of entity or individual is required. Provide entity for legal entities (corporations, LLCs, etc.) and individual for natural persons.
BeneficiaryExternalAccountRequest
object
Destination wallet for the payout. Exactly one of externalaccountid (references an existing approved external account on the resolved beneficiary) or info (inl…
PostPayoutsSubmitResponse
object
Slim acknowledgement returned for submit-mode requests (HTTP 202). Full resource state is retrieved via GET /payouts or observed via payout.statusupdated webho…
3 properties3 required
PayoutResourceBeneficiary
object
Beneficiary lifecycle view. Full beneficiary PII (name, DOB, address, ID numbers, etc.) is NOT included here — fetch via GET /participants/{participantcode}.
3 properties
PaymentBlock
object
4 properties3 required
Code503
object
A downstream dependency was unavailable, timed out, or returned a retryable error. Safe to retry; the response carries a zh-allow-retry: true header.
1 property1 required
Code403
object
Authentication or authorization failed. error is always true; message explains which check failed (missing API key, bad signature, insufficient permission, etc…
2 properties2 required
PostPayoutsRequest
object
Payout submission or pre-flight validation. When validate: true, zerohash runs the full validation pipeline (schema, business-logic, and address-validity check…
6 properties4 required
Code404
object
The requested resource does not exist or is not visible to the caller.
1 property1 required
GetPayoutsResponse
object
Lifecycle-only view of a payout. PII (beneficiary natural-person fields, inline payor info.entity data, etc.) is NOT returned here — fetch from the per-resourc…
10 properties7 required
BeneficiaryBlock
object
Beneficiary block — the participant receiving the funds. Exactly one of participantcode (references an existing approved beneficiary) or info (inline entity/in…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Zero Hash Payouts API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.