--- updatedAt: 2026-06-02T20:06:00.000Z agentTools: projectIndex: https://docs.zerohash.com/llms.txt --- # Close external account Closes an external account previously linked to a participant. After closure the account can no longer be used for new payments. # 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/external_accounts/{external_account_id}/close": { "post": { "tags": [ "Payments" ], "summary": "Close external account", "description": "Closes an external account previously linked to a participant. After closure the account can no longer be used for new payments.", "parameters": [ { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/Timestamp" }, { "name": "external_account_id", "in": "path", "description": "Identifier of the external account to close.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Close request. `participant_code` identifies the account owner.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostCloseExternalAccountRequest" } } } }, "responses": { "200": { "description": "External account closed. Response contains the final snapshot of the account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostCloseExternalAccountResponse" } } } }, "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" } } }, "PostCloseExternalAccountRequest": { "type": "object", "additionalProperties": false, "required": [ "participant_code" ], "properties": { "participant_code": { "type": "string", "minLength": 6, "description": "Participant that owns the external account being closed.", "example": "ABCDEF" } } }, "PostCloseExternalAccountResponse": { "type": "object", "properties": { "request_id": { "type": "string", "description": "RequestID", "example": "0f68333e-2114-469d-b505-c850d776e063" }, "external_account": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Bank account number", "example": "123456789" }, "routing_number": { "type": "string", "description": "Routing number, routing number needs to be 9 characters and can only be integers [0-9]", "example": "011401533" }, "participant_code": { "type": "string", "description": "Participant code", "example": "ALI123" }, "platform_code": { "type": "string", "description": "Platform code", "example": "TES123" }, "account_nickname": { "type": "string", "description": "Account nickname", "example": "test1" }, "account_type": { "type": "string", "description": "Fiat account type", "enum": [ "checking", "savings" ] }, "status": { "type": "string", "description": "Account status", "enum": [ "pending", "approved", "rejected", "locked", "disabled", "revoked", "closed" ] }, "external_account_id": { "type": "string", "description": "Linked account id", "example": "0f68333e-2114-469d-b505-c850d776e063" }, "created_at": { "type": "string", "format": "date-time", "description": "Creation timestamp of the account.", "example": "2026-05-04T11:54:13.099Z" } } } } } } } } ```