> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/validate-bank-account/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.shimi.cash/_mcp/server. # Validate Bank Account POST https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account Content-Type: application/json Resolves a beneficiary account name before paying out to it, and reserves a `verify_id` for the next 15 minutes to use in **Send Payout**. **Errors:** `400` invalid PIN, account does not exist, or settlement account not found. **Body (JSON)** - checked by Joi (`verifysettlementPayoutSchema`). | Field | Type | Required | Rules | | ------------------ | ------ | -------- | ------------------------------------------------------------------------- | | `bank_code` | string | yes | 4-10 chars; use a `code` from List Supported Banks (e.g. `000013` GTBank) | | `account_number` | string | yes | 9-11 chars (10-digit NUBAN) | | `pin` | string | yes | exactly 4 chars - your transaction PIN | | `fromSettlementId` | number | yes | The settlement account to pay from | **Behaviour notes** * Resolves the beneficiary name. `data.id` is the `verify_id` for **Send Payout**, and later the payout `reference` used by Check Payout Status / Fetch One Settlement Transaction. * The code sets **no expiry** on a `verify_id`. * Each `verify_id` can be used for **one** payout only. * Business errors are HTTP 400 `{ "error": " failed: " }`; the message starts with a space. Reference: https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/validate-bank-account ## Authentication - `Authorization` header (bearer token, required) — Access token from Generate Access Token (valid 15 minutes). ## Request ### Body (application/json) This endpoint expects an object. - `bank_code` (string, optional) - `account_number` (string, optional) - `pin` (string, optional) - `fromSettlementId` (integer, optional) ## Response ### 200 OK - `data` (SettlementValidateAccountPostResponsesContentApplicationJsonSchemaData, optional) ## Errors ### 400 Bad Request Error Validation error / Invalid PIN / Account does not exist / Settlement account not found / PIN not set up - `status` (string, optional) - `message` (string, optional) - `details` (list of string, optional) - `error` (string, optional) ### 401 Unauthorized Error Unauthorized - `message` (string, optional) ### 403 Forbidden Error Invalid or expired access token / KYB not approved / Account deactivated - `message` (string, optional) - `code` (string, optional) - `kybStatus` (string, optional) ## Types ### SettlementValidateAccountPostResponsesContentApplicationJsonSchemaData - `id` (string, optional) - `account_name` (string, optional) - `account_number` (string, optional) ## Examples ### 200 Success **Response** ```json { "data": { "id": "cmgb3n7q20007lp4x9s1t6e8d", "account_name": "EMEKA JOHN NWOSU", "account_number": "0123456789" } } ``` **SDK Code** ```python 200 Success import requests url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account" headers = {"Authorization": "Bearer "} response = requests.post(url, headers=headers) print(response.json()) ``` ```javascript 200 Success const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account'; const options = {method: 'POST', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 Success package main import ( "fmt" "net/http" "io" ) func main() { url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account" req, _ := http.NewRequest("POST", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 Success require 'uri' require 'net/http' url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 Success import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 Success request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 Success using RestSharp; var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 Success import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers 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() ``` ### Settlement & Payouts_validateBankAccount_example **Request** ```json { "bank_code": "000016", "account_number": "2029378380", "pin": "1234", "fromSettlementId": 1 } ``` **Response** ```json { "data": { "id": "cmgb3n7q20007lp4x9s1t6e8d", "account_name": "EMEKA JOHN NWOSU", "account_number": "0123456789" } } ``` **SDK Code** ```python Settlement & Payouts_validateBankAccount_example import requests url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account" payload = { "bank_code": "000016", "account_number": "2029378380", "pin": "1234", "fromSettlementId": 1 } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Settlement & Payouts_validateBankAccount_example const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"bank_code":"000016","account_number":"2029378380","pin":"1234","fromSettlementId":1}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Settlement & Payouts_validateBankAccount_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account" payload := strings.NewReader("{\n \"bank_code\": \"000016\",\n \"account_number\": \"2029378380\",\n \"pin\": \"1234\",\n \"fromSettlementId\": 1\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 Settlement & Payouts_validateBankAccount_example require 'uri' require 'net/http' url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-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 \"bank_code\": \"000016\",\n \"account_number\": \"2029378380\",\n \"pin\": \"1234\",\n \"fromSettlementId\": 1\n}" response = http.request(request) puts response.read_body ``` ```java Settlement & Payouts_validateBankAccount_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"bank_code\": \"000016\",\n \"account_number\": \"2029378380\",\n \"pin\": \"1234\",\n \"fromSettlementId\": 1\n}") .asString(); ``` ```php Settlement & Payouts_validateBankAccount_example request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account', [ 'body' => '{ "bank_code": "000016", "account_number": "2029378380", "pin": "1234", "fromSettlementId": 1 }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Settlement & Payouts_validateBankAccount_example using RestSharp; var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-account"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"bank_code\": \"000016\",\n \"account_number\": \"2029378380\",\n \"pin\": \"1234\",\n \"fromSettlementId\": 1\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Settlement & Payouts_validateBankAccount_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "bank_code": "000016", "account_number": "2029378380", "pin": "1234", "fromSettlementId": 1 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/validate-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() ```