> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.haloinvest.ng/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.haloinvest.ng/_mcp/server. # Close account POST https://api.haloinvest.ng/api/banking/account/close-account Content-Type: application/json 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. Reference: https://docs.haloinvest.ng/api-reference/accounts/close-account ## Authentication - `Authorization` header (bearer token, required) — Your Halo partner API key, sent as `Authorization: Bearer `. ## Request ### Body (application/json) This endpoint expects an object. - `accountNumber` (string, required) — An account number your business opened. - `narration` (string, required) — The reason for closing the account. ## Response ### 200 Success. - `status` (boolean, optional) - `message` (string, optional) - `data` (list of any, optional) - `status_code` (integer, optional) ## Errors ### 400 Bad Request Error The account was not found for your business, or the bank refused the closure. - `status` (boolean, required) — True on success, false otherwise. - `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists. - `status_code` (integer, required) — The HTTP status code. - `data` (any, optional) — The result. Left out on most errors. ### 401 Unauthorized Error The API key is missing or not recognised, or your business is switched off. - `error` (UnauthorizedErrorError, optional) ### 422 Unprocessable Entity Error The account still holds money, or the request failed validation. - `status` (boolean, required) — True on success, false otherwise. - `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists. - `status_code` (integer, required) — The HTTP status code. - `data` (any, optional) — The result. Left out on most errors. ### 429 Too Many Requests Error Too many requests. Wait and try again. - `status` (boolean, required) — True on success, false otherwise. - `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists. - `status_code` (integer, required) — The HTTP status code. - `data` (any, optional) — The result. Left out on most errors. ### 500 Internal Server Error The closure could not be sent. - `status` (boolean, required) — True on success, false otherwise. - `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists. - `status_code` (integer, required) — The HTTP status code. - `data` (any, optional) — The result. Left out on most errors. ### 502 Bad Gateway Error The bank did not confirm the closure. Check the account before trying again. - `status` (boolean, required) — True on success, false otherwise. - `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists. - `status_code` (integer, required) — The HTTP status code. - `data` (any, optional) — The result. Left out on most errors. ### 503 Service Unavailable Error The balance could not be confirmed with the bank. Try again later. - `status` (boolean, required) — True on success, false otherwise. - `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists. - `status_code` (integer, required) — The HTTP status code. - `data` (any, optional) — The result. Left out on most errors. ## Types ### EnvelopeMessage A short message. On a 422 validation failure it is an object of field names to error lists. - string - map from string to list of string ### UnauthorizedErrorError - `message` (string, optional) ## Examples **Request** ```json { "accountNumber": "1100000001", "narration": "Customer request" } ``` **Response** ```json { "status": true, "message": "Account was closed successfully", "data": [], "status_code": 200 } ``` **SDK Code** ```python import requests url = "https://api.haloinvest.ng/api/banking/account/close-account" payload = { "accountNumber": "1100000001", "narration": "Customer request" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.haloinvest.ng/api/banking/account/close-account'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"accountNumber":"1100000001","narration":"Customer request"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.haloinvest.ng/api/banking/account/close-account" payload := strings.NewReader("{\n \"accountNumber\": \"1100000001\",\n \"narration\": \"Customer request\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.haloinvest.ng/api/banking/account/close-account") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"accountNumber\": \"1100000001\",\n \"narration\": \"Customer request\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.haloinvest.ng/api/banking/account/close-account") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"accountNumber\": \"1100000001\",\n \"narration\": \"Customer request\"\n}") .asString(); ``` ```php request('POST', 'https://api.haloinvest.ng/api/banking/account/close-account', [ 'body' => '{ "accountNumber": "1100000001", "narration": "Customer request" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.haloinvest.ng/api/banking/account/close-account"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"accountNumber\": \"1100000001\",\n \"narration\": \"Customer request\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "accountNumber": "1100000001", "narration": "Customer request" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.haloinvest.ng/api/banking/account/close-account")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```