Skip to navigation
API ReferenceAccounts

Close account

Closes an account your business opened. Halo asks the bank for the live balance first and closes the account only when both the available and the ledger balance are zero. Move any money out before closing.

Authentication

AuthorizationBearer

Your Halo partner API key, sent as Authorization: Bearer <key>.

Request

This endpoint expects an object.
accountNumberstringRequired
An account number your business opened.
narrationstringRequired
The reason for closing the account.

Response

Success.
statusbooleanOptional
messagestringOptional
datalist of anyOptional
status_codeintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error