--- updatedAt: 2026-06-02T20:06:00.000Z agentTools: projectIndex: https://docs.zerohash.com/llms.txt --- # List pending ACH settlements Retrieves pending ACH settlements for a specific platform. Used by the platform to reconcile the daily ACH settlement window. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "zerohash API", "description": "\n### Authentication\n\nzerohash Uses HMAC SHA-256 verification to ensure the authenticity of API requests, follow instructions by link [https://docs.zerohash.com/reference/api-authentication](https://docs.zerohash.com/reference/api-authentication)\n\nDownload zerohash OpenAPI Schema as JSON\n", "version": "1.7.0" }, "servers": [ { "url": "https://api.cert.zerohash.com", "description": "Certification API server" } ], "x-readme": { "proxy-enabled": false }, "tags": [ { "name": "Payments", "description": "Payment Services" } ], "paths": { "/payments/settlements": { "get": { "tags": [ "Payments" ], "summary": "List pending ACH settlements", "description": "Retrieves pending ACH settlements for a specific platform. Used by the platform to reconcile the daily ACH settlement window.", "parameters": [ { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/Timestamp" }, { "name": "start_date", "in": "query", "description": "Inclusive start of the query window as a Unix timestamp in seconds. Defaults to 2 days ago.", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1777722086 } }, { "name": "end_date", "in": "query", "description": "Inclusive end of the query window as a Unix timestamp in seconds. Defaults to now.", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1777895286 } }, { "name": "platform_code", "in": "query", "description": "Platform code to fetch pending settlements for.", "required": true, "schema": { "type": "string", "example": "DEMO01" } }, { "name": "page", "in": "query", "description": "Filter for a specific page (pagination)", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "size", "in": "query", "description": "Filter for the amount of pending ACH transaction objects returned", "required": false, "schema": { "type": "number", "default": 200 } } ], "responses": { "200": { "description": "Successfully retrieved paginated list of pending ACH settlements with optional filters: platform_code, start_date, end_date.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPendingACHTransactionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code400" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code404" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code500" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code503" } } } } } } } }, "security": [ { "apiKey": [], "apiPassphrase": [] } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "description": "Your API public key. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for how to obtain keys.", "in": "header", "name": "X-SCX-API-KEY" }, "apiPassphrase": { "type": "apiKey", "description": "The passphrase associated with your API key, set when the key was created.", "in": "header", "name": "X-SCX-PASSPHRASE" } }, "parameters": { "Signature": { "name": "X-SCX-SIGNED", "in": "header", "description": "HMAC-SHA256 signature of the request, base64-encoded. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for the exact signing formula.", "required": true, "schema": { "type": "string" } }, "Timestamp": { "name": "X-SCX-TIMESTAMP", "in": "header", "description": "Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.", "required": true, "schema": { "type": "string", "example": "1678901234" } } }, "schemas": { "Code400": { "type": "object", "description": "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 business-rule violation.", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "string" }, "example": [ "body/amount must be >= 0", "body/asset is required" ] } } }, "Code403": { "type": "object", "description": "Authentication or authorization failed. `error` is always `true`; `message` explains which check failed (missing API key, bad signature, insufficient permission, etc.).", "required": [ "error", "message" ], "properties": { "error": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "This api key does not have write permission to this endpoint" } } }, "Code404": { "type": "object", "description": "The requested resource does not exist or is not visible to the caller.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Not Found" } } }, "Code500": { "type": "object", "description": "An unexpected error occurred on the server. The request can be retried after a short delay, but the same inputs may reproduce the error.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Internal Server Error" } } }, "Code503": { "type": "object", "description": "A downstream dependency was unavailable, timed out, or returned a retryable error. Safe to retry; the response carries a `zh-allow-retry: true` header.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Service Unavailable" } } }, "PendingACHTransactions": { "type": "object", "properties": { "processing_window_date": { "type": "string", "format": "date-time", "description": "Processing window date the pending transaction is queued for.", "example": "2026-05-04T00:00:00.000Z" }, "trade_id": { "type": "string", "format": "uuid", "description": "Linked trade identifier.", "example": "0f34533e-2114-469d-b505-c850d776e061" }, "transaction_type": { "type": "string", "enum": [ "credit", "debit", "unspecified" ], "description": "Direction of the pending ACH transfer. `credit` pays the participant, `debit` pulls funds from the participant." }, "participant_code": { "type": "string", "description": "Participant the pending transaction belongs to.", "example": "ABCDEF" }, "amount": { "type": "string", "description": "Transaction amount in USD.", "example": "12.01" } } }, "GetPendingACHTransactionsResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Request identifier echoed back from the request.", "example": "0f68333e-2114-469d-b505-c850d776e063" }, "message": { "type": "array", "items": { "$ref": "#/components/schemas/PendingACHTransactions" } }, "page": { "type": "number", "example": 1 }, "page_size": { "type": "number", "example": 200 }, "count": { "type": "number", "example": 10 } } } } } } ```