> 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/check-payout-status/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.shimi.cash/_mcp/server. # Check Payout Status GET https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/{id} Polls the current status of a payout — use this after receiving a `202` from **Send Payout**, or any time you want to confirm a payout's outcome. `status` is one of: `PENDING` (still resolving — check back or wait for the webhook), `success`, or `failed`. **Path parameter:** `id` (string, required) - the payout `reference` (= `verify_id`). **Behaviour notes** * `status` is `PENDING`, `success` or `failed`. Internal `SUBMITTING` / `PROCESSING` states are reported as `PENDING`. * `fee` is the payout fee charged on top of `amount` (both NGN). * A `verify_id` that was validated but never used for a payout also shows `PENDING`, with `amount: 0` and `fee: 0`. * Unknown id: `404 { "error": "Transfer not found" }`. Reference: https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/check-payout-status ## Authentication - `Authorization` header (bearer token, required) — Access token from Generate Access Token (valid 15 minutes). ## Request ### Path parameters - `id` (string, required) — The payout reference (`verify_id` used in Send Payout, i.e. the `reference` field on its response). ## Response ### 200 Pending / Success / Failed - `data` (SettlementTransferIdGetResponsesContentApplicationJsonSchemaData, optional) ## Errors ### 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) ### 404 Not Found Error Not Found - `error` (string, optional) ## Types ### SettlementTransferIdGetResponsesContentApplicationJsonSchemaData - `reference` (string, optional) - `status` (string, optional) - `amount` (integer, optional) - `fee` (integer, optional) - `account_number` (string, optional) - `account_name` (string, optional) ## Examples ### 200 Pending **Response** ```json { "data": { "reference": "cmgb3n7q20007lp4x9s1t6e8d", "status": "PENDING", "amount": 50000, "fee": 50, "account_number": "0123456789", "account_name": "EMEKA JOHN NWOSU" } } ``` **SDK Code** ```python 200 Pending import requests url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 Pending const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id'; const options = {method: 'GET', 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 Pending package main import ( "fmt" "net/http" "io" ) func main() { url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id" req, _ := http.NewRequest("GET", 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 Pending require 'uri' require 'net/http' url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 Pending import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 Pending request('GET', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 Pending using RestSharp; var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 Pending import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" 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() ``` ### 200 Success **Response** ```json { "data": { "reference": "cmgb3n7q20007lp4x9s1t6e8d", "status": "success", "amount": 50000, "fee": 50, "account_number": "0123456789", "account_name": "EMEKA JOHN NWOSU" } } ``` **SDK Code** ```python 200 Success import requests url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 Success const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id'; const options = {method: 'GET', 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/transfer/id" req, _ := http.NewRequest("GET", 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/transfer/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.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.get("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 Success request('GET', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id', [ '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/transfer/id"); var request = new RestRequest(Method.GET); 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/transfer/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" 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() ``` ### 200 Failed **Response** ```json { "data": { "reference": "cmgb3n7q20007lp4x9s1t6e8d", "status": "failed", "amount": 50000, "fee": 50, "account_number": "0123456789", "account_name": "EMEKA JOHN NWOSU" } } ``` **SDK Code** ```python 200 Failed import requests url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 Failed const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id'; const options = {method: 'GET', 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 Failed package main import ( "fmt" "net/http" "io" ) func main() { url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id" req, _ := http.NewRequest("GET", 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 Failed require 'uri' require 'net/http' url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 Failed import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 Failed request('GET', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 Failed using RestSharp; var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 Failed import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" 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() ```