Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
startDate
string<date>
Start date for filtering payouts . Accepted formats : YYYY-MM-DD or DD-MM-YYYY
endDate
string<date>
End date for filtering payouts . Accepted formats : YYYY-MM-DD or DD-MM-YYYY
channel
enum<string>
Payout channel filter
Available options:
BANK TRANSFER,
MOBILE MONEY,
TIPS LIPA NAMBA
currency
string
Currency filter (e.g., TZS, USD)
orderReference
string
Order reference filter
status
enum<string>
Payout status filter
Available options:
AUTHORIZED,
SUCCESS,
PROCESSING,
PENDING,
FAILED,
REFUNDED,
REVERSED
transferType
enum<string>
Filter by settlement type
Available options:
ACH,
RTGS,
GTB
clientId
string
Client ID filter
sortBy
string
Field to sort by (default: createdAt). All response fields are sortable including beneficiary fields
orderBy
enum<string>
default:DESC
Sort order (default: DESC)
Available options:
ASC,
DESC
skip
integer
default:0
Number of records to skip for pagination
Required range: x >= 0
limit
integer
default:20
Number of records to return
Required range: x >= 1
Response
Query all payouts response
data
object[]
Array of payout records
Show child attributes
totalCount
integer
Total number of payouts matching the query criteria
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"ClickPesa Documentation","description":"ClickPesa API Documentation","colors":{"primary":"#e6c602","light":"#fbd906","dark":"#fbe550"},"logo":{"light":"https://mintcdn.com/clickpesa/qdSCR2hZ0bZ9aNG2/logo/light.png?fit=max\u0026auto=format\u0026n=qdSCR2hZ0bZ9aNG2\u0026q=85\u0026s=0c7d827509008d22f2ae1572a6c7821c","dark":"https://mintcdn.com/clickpesa/qdSCR2hZ0bZ9aNG2/logo/dark.png?fit=max\u0026auto=format\u0026n=qdSCR2hZ0bZ9aNG2\u0026q=85\u0026s=f738996085c1fb0884dcd49a587c19b5"},"favicon":"https://mintcdn.com/clickpesa/qdSCR2hZ0bZ9aNG2/favicon.png?fit=max\u0026auto=format\u0026n=qdSCR2hZ0bZ9aNG2\u0026q=85\u0026s=69ce6a97d09d672973f96138ffebc55b","background":{"color":{"light":"#ffffff","dark":"#181a1b"}},"navbar":{"links":[{"href":"mailto:aly@clickpesa.com","label":"Support"}],"primary":{"type":"button","label":"Register","href":"https://merchant.clickpesa.com/account-registration"}},"footer":{"socials":{"x":"https://x.com/clickpesa","linkedin":"https://www.linkedin.com/company/clickpesa"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clickpesa","hasAudioNarration":false,"actualSubdomain":"clickpesa","customDomains":["docs.clickpesa.com"],"gitSource":{"type":"github","owner":"clickpesa","repo":"developers.docs","deployBranch":"release-v1.0.0","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af4202c911eab1428da364b","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API Explorer","count":38},{"language":"default","tag":"How It Works","count":38},{"language":"default","tag":"Merchant Dashboard","count":27},{"language":"default","tag":"Getting Started","count":14},{"language":"default","tag":"Settings","count":8},{"language":"default","tag":"BILLPAY","count":7},{"language":"default","tag":"BillPay","count":7},{"language":"default","tag":"BANK PAYOUTS","count":5},{"language":"default","tag":"LIPA NAMBA PAYOUTS","count":5},{"language":"default","tag":"Hosted Checkout","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".payment-methods-card .card img{width:6em;margin:auto;padding-top:1em}#sidebar{width:auto}#footer>div>div{display:none}"}],"page":{"pagePath":"api-reference/disbursement/mno-payout/query-all-payouts","slug":"/api-reference/disbursement/mno-payout/query-all-payouts","pageMetadata":{"title":"Query All Payouts","openapi":"GET /payouts/all","description":"Query all payouts with filtering, sorting, and pagination capabilities","href":"/api-reference/disbursement/mno-payout/query-all-payouts"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Query all payouts with filtering, sorting, and pagination capabilities\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Query All Payouts","openapi":"GET /payouts/all","description":"Query all payouts with filtering, sorting, and pagination capabilities","href":"/api-reference/disbursement/mno-payout/query-all-payouts"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Query all payouts with filtering, sorting, and pagination capabilities","parameters":["06735c13-b4e5-4e7f-8068-67d07c8fbbbc","66935677-6756-47b7-9f43-1c3066921914","8fff65bc-f2e3-486c-a915-4e68edd5850d","d89b89a4-b1cd-4819-a816-e8f98fc9a12c","fb3bf5dd-5969-4ee5-86dd-43e8b7bef307","c7ab5c28-9e9b-445f-941f-29a31f661827","45002992-8fd1-4d1e-b522-f3735489d925","a0705855-dfe4-4df2-9780-f8331aa96549","9d2479a5-50bf-4c2e-8332-37cb2cb4fad5","e9d95163-e6d1-45bf-94de-eefec4b9a761","7736f86d-906e-447b-894f-cc4248e7cdb6","a4bcf076-00af-4b0f-9206-c6563fca7a20"],"responses":{"200":"510c6a87-961a-406c-a7a5-b4fdfc491db9","400":"91fa671c-1e5e-4c63-9fe0-9bf8e2a9448c","401":"0c21a788-b1b1-4e79-9b49-98d76cb68268"},"method":"get","type":"path","servers":["17a8e8f2-8faa-4cc3-8e71-e8754d9ba461"],"security":["e5b45081-f6d6-41fd-aefa-e9e3e9603799"],"path":"/payouts/all","baseUrlOptions":["https://api.clickpesa.com/third-parties"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"06735c13-b4e5-4e7f-8068-67d07c8fbbbc":{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date","isRequired":false,"description":"Start date for filtering payouts . Accepted formats : `YYYY-MM-DD` or `DD-MM-YYYY`","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Start date for filtering payouts . Accepted formats : `YYYY-MM-DD` or `DD-MM-YYYY`"},"66935677-6756-47b7-9f43-1c3066921914":{"name":"endDate","in":"query","required":false,"schema":{"type":"string","format":"date","isRequired":false,"description":"End date for filtering payouts . Accepted formats : `YYYY-MM-DD` or `DD-MM-YYYY`","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"End date for filtering payouts . Accepted formats : `YYYY-MM-DD` or `DD-MM-YYYY`"},"8fff65bc-f2e3-486c-a915-4e68edd5850d":{"name":"channel","in":"query","required":false,"schema":{"type":"string","enum":["BANK TRANSFER","MOBILE MONEY","TIPS LIPA NAMBA"],"isRequired":false,"description":"Payout channel filter","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Payout channel filter"},"d89b89a4-b1cd-4819-a816-e8f98fc9a12c":{"name":"currency","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Currency filter (e.g., TZS, USD)","uniqueKey":"","typeLabel":"string"},"description":"Currency filter (e.g., TZS, USD)"},"fb3bf5dd-5969-4ee5-86dd-43e8b7bef307":{"name":"orderReference","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Order reference filter","uniqueKey":"","typeLabel":"string"},"description":"Order reference filter"},"c7ab5c28-9e9b-445f-941f-29a31f661827":{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["AUTHORIZED","SUCCESS","PROCESSING","PENDING","FAILED","REFUNDED","REVERSED"],"isRequired":false,"description":"Payout status filter","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Payout status filter"},"45002992-8fd1-4d1e-b522-f3735489d925":{"name":"transferType","in":"query","required":false,"schema":{"type":"string","enum":["ACH","RTGS","GTB"],"isRequired":false,"description":"Filter by settlement type","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter by settlement type"},"a0705855-dfe4-4df2-9780-f8331aa96549":{"name":"clientId","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Client ID filter","uniqueKey":"","typeLabel":"string"},"description":"Client ID filter"},"9d2479a5-50bf-4c2e-8332-37cb2cb4fad5":{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Field to sort by (default: createdAt). All response fields are sortable including beneficiary fields","uniqueKey":"","typeLabel":"string"},"description":"Field to sort by (default: createdAt). All response fields are sortable including beneficiary fields"},"e9d95163-e6d1-45bf-94de-eefec4b9a761":{"name":"orderBy","in":"query","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC","isRequired":false,"description":"Sort order (default: DESC)","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Sort order (default: DESC)"},"7736f86d-906e-447b-894f-cc4248e7cdb6":{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"isRequired":false,"description":"Number of records to skip for pagination","uniqueKey":"","typeLabel":"integer"},"description":"Number of records to skip for pagination"},"a4bcf076-00af-4b0f-9206-c6563fca7a20":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":20,"isRequired":false,"description":"Number of records to return","uniqueKey":"","typeLabel":"integer"},"description":"Number of records to return"}},"responses":{"510c6a87-961a-406c-a7a5-b4fdfc491db9":{"description":"Query all payouts response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","description":"Last updated timestamp","uniqueKey":"data.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp","uniqueKey":"data.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","description":"Payout ID","uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"orderReference":{"type":"string","description":"Associated order reference","uniqueKey":"data.items.[INDEX].orderReference","typeLabel":"string"},"amount":{"type":"string","description":"Payout amount","uniqueKey":"data.items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","description":"Currency code","uniqueKey":"data.items.[INDEX].currency","typeLabel":"string"},"fee":{"type":"string","description":"Transaction fee","uniqueKey":"data.items.[INDEX].fee","typeLabel":"string"},"status":{"type":"string","description":"Payout status","enum":["AUTHORIZED","SUCCESS","PROCESSING","PENDING","FAILED","REFUNDED","REVERSED"],"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"exchanged":{"type":"boolean","description":"Indicates if currency conversion was applied (true when source currency differs from receiving currency)","example":true,"uniqueKey":"data.items.[INDEX].exchanged","typeLabel":"boolean"},"exchange":{"type":"object","description":"Exchange rate details (only present when exchanged is true)","properties":{"sourceCurrency":{"type":"string","description":"Source currency for the exchange","example":"USD","uniqueKey":"data.items.[INDEX].exchange.sourceCurrency","typeLabel":"string"},"targetCurrency":{"type":"string","description":"Target currency for the exchange","example":"TZS","uniqueKey":"data.items.[INDEX].exchange.targetCurrency","typeLabel":"string"},"sourceAmount":{"type":"number","description":"Amount in source currency","example":1000,"uniqueKey":"data.items.[INDEX].exchange.sourceAmount","typeLabel":"number"},"rate":{"type":"number","description":"Exchange rate used for conversion","example":2500,"uniqueKey":"data.items.[INDEX].exchange.rate","typeLabel":"number"}},"uniqueKey":"data.items.[INDEX].exchange","typeLabel":"object"},"channel":{"type":"string","description":"Payment channel","enum":["BANK TRANSFER","MOBILE MONEY","TIPS LIPA NAMBA"],"uniqueKey":"data.items.[INDEX].channel","typeLabel":"enum\u003cstring>"},"channelProvider":{"type":"string","description":"Name of the payment provider","uniqueKey":"data.items.[INDEX].channelProvider","typeLabel":"string"},"settlementType":{"type":"string","description":"Settlement type, when applicable","enum":["ACH","RTGS","GTB"],"uniqueKey":"data.items.[INDEX].settlementType","typeLabel":"enum\u003cstring>"},"notes":{"type":"string","description":"Additional notes if available","uniqueKey":"data.items.[INDEX].notes","typeLabel":"string"},"beneficiary":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Beneficiary's account number","uniqueKey":"data.items.[INDEX].beneficiary.accountNumber","typeLabel":"string"},"accountName":{"type":"string","description":"Beneficiary's account name","uniqueKey":"data.items.[INDEX].beneficiary.accountName","typeLabel":"string"},"swiftNumber":{"type":"string","description":"SWIFT number if applicable","uniqueKey":"data.items.[INDEX].beneficiary.swiftNumber","typeLabel":"string"},"routingNumber":{"type":"string","description":"Routing number if applicable","uniqueKey":"data.items.[INDEX].beneficiary.routingNumber","typeLabel":"string"},"beneficiaryMobileNumber":{"type":"string","description":"Beneficiary's mobile number if applicable","uniqueKey":"data.items.[INDEX].beneficiary.beneficiaryMobileNumber","typeLabel":"string"},"beneficiaryEmail":{"type":"string","format":"email","description":"Beneficiary's email if applicable","uniqueKey":"data.items.[INDEX].beneficiary.beneficiaryEmail","typeLabel":"string\u003cemail>"}},"uniqueKey":"data.items.[INDEX].beneficiary","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"Array of payout records","uniqueKey":"data","typeLabel":"object[]"},"totalCount":{"type":"integer","description":"Total number of payouts matching the query criteria","uniqueKey":"totalCount","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"updatedAt":"2023-11-07T05:31:56Z","createdAt":"2023-11-07T05:31:56Z","id":"\u003cstring>","orderReference":"\u003cstring>","amount":"\u003cstring>","currency":"\u003cstring>","fee":"\u003cstring>","status":"AUTHORIZED","exchanged":true,"exchange":{"sourceCurrency":"USD","targetCurrency":"TZS","sourceAmount":1000,"rate":2500},"channel":"BANK TRANSFER","channelProvider":"\u003cstring>","settlementType":"ACH","notes":"\u003cstring>","beneficiary":{"accountNumber":"\u003cstring>","accountName":"\u003cstring>","swiftNumber":"\u003cstring>","routingNumber":"\u003cstring>","beneficiaryMobileNumber":"\u003cstring>","beneficiaryEmail":"jsmith@example.com"}}],"totalCount":123}}},"exampleType":"generated"}},"exampleType":"generated"},"91fa671c-1e5e-4c63-9fe0-9bf8e2a9448c":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Bad request error message","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0c21a788-b1b1-4e79-9b49-98d76cb68268":{"description":"Invalid or Expired Token","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Unauthorized Error","example":"Unauthorized","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e5b45081-f6d6-41fd-aefa-e9e3e9603799":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"17a8e8f2-8faa-4cc3-8e71-e8754d9ba461":{"url":"https://api.clickpesa.com/third-parties"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/disbursement/query-all-payouts/openapi.json"},"subdomain":"clickpesa","siteName":"ClickPesa Documentation","title":"Query All Payouts - ClickPesa Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-16T01:42:01.701Z","originalFileLocation":"api-reference/disbursement/mno-payout/query-all-payouts.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Query all payouts with filtering, sorting, and pagination capabilities\">\u003cmeta data-mint-head name=\"application-name\" content=\"ClickPesa Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Query All Payouts - ClickPesa Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Query all payouts with filtering, sorting, and pagination capabilities\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ClickPesa Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clickpesa.mintlify.site/_mintlify/api/og/v2?division=MOBILE+PAYOUTS\u0026amp;title=Query+All+Payouts\u0026amp;description=Query+all+payouts+with+filtering%2C+sorting%2C+and+pagination+capabilities\u0026amp;theme=23bfaf57b6f15b5e659cc1e8\u0026amp;signature=ee45815fa52d4a64f216f04121e7c8e5cf574d8a9bf244cdbf9619c125de073a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Query All Payouts - ClickPesa Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Query all payouts with filtering, sorting, and pagination capabilities\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clickpesa.mintlify.site/_mintlify/api/og/v2?division=MOBILE+PAYOUTS\u0026amp;title=Query+All+Payouts\u0026amp;description=Query+all+payouts+with+filtering%2C+sorting%2C+and+pagination+capabilities\u0026amp;theme=23bfaf57b6f15b5e659cc1e8\u0026amp;signature=ee45815fa52d4a64f216f04121e7c8e5cf574d8a9bf244cdbf9619c125de073a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/clickpesa/PSQHr0_JRNaAV5W5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ClickPesa Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e6c602\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/disbursement/mno-payout/query-all-payouts.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clickpesa.com/#organization\",\"name\":\"ClickPesa Documentation\",\"url\":\"https://docs.clickpesa.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clickpesa/qdSCR2hZ0bZ9aNG2/logo/light.png?fit=max\u0026auto=format\u0026n=qdSCR2hZ0bZ9aNG2\u0026q=85\u0026s=0c7d827509008d22f2ae1572a6c7821c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clickpesa.com#website\",\"name\":\"ClickPesa Documentation\",\"url\":\"https://docs.clickpesa.com\",\"publisher\":{\"@id\":\"https://docs.clickpesa.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts#webpage\",\"url\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts\",\"name\":\"Query All Payouts\",\"description\":\"Query all payouts with filtering, sorting, and pagination capabilities\",\"dateModified\":\"2025-08-16T01:42:01.701Z\",\"isPartOf\":{\"@id\":\"https://docs.clickpesa.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"MOBILE PAYOUTS\",\"item\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/preview-mno-payout\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Query All Payouts\",\"item\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts#apireference\",\"headline\":\"Query All Payouts\",\"name\":\"Query All Payouts\",\"description\":\"Query all payouts with filtering, sorting, and pagination capabilities\",\"url\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts#webpage\"},\"dateModified\":\"2025-08-16T01:42:01.701Z\",\"publisher\":{\"@id\":\"https://docs.clickpesa.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clickpesa.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ClickPesa Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ClickPesa Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/disbursement/mno-payout/query-all-payouts.md","siteName":"ClickPesa Documentation","nav":{"global":null,"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/home/introduction"}]},{"tab":"Merchant Dashboard","pages":[{"title":"Merchant Dashboard","href":"/dashboard/dashboard-overview"}]},{"tab":"Hosted Checkout","pages":[{"title":"Hosted Checkout","href":"/checkout/checkout-overview"}]},{"tab":"Mobile USSD-PUSH API","pages":[{"title":"Mobile USSD-PUSH API","href":"/payment-api/mobile-money-payment-api/mobile-money-payment-api-overview"}]},{"tab":"Card API","pages":[{"title":"Card API","href":"/payment-api/card-payment-api/card-payment-api-overview"}]},{"tab":"BillPay","pages":[{"title":"BillPay","href":"/bill-pay/bill-pay-overview"}]},{"tab":"TanQR/Lipa Namba","pages":[{"title":"TanQR/Lipa Namba","href":"/tan-qr/tan-qr-overview"}]},{"tab":"CRDB Direct Debit","pages":[{"title":"CRDB Direct Debit","href":"/crdb-direct-debit/crdb-direct-debit-overview"}]},{"tab":"Mobile Payouts API","pages":[{"title":"Mobile Payouts API","href":"/payout-api/mobile-money-payout-api/mobile-money-payout-api-overview"}]},{"tab":"Bank Payout API","pages":[{"title":"Bank Payout API","href":"/payout-api/bank-payout-api/bank-payout-api-overview"}]},{"tab":"Lipa Namba Payout API","pages":[{"title":"Lipa Namba Payout API","href":"/payout-api/lipa-namba-payout-api/lipa-namba-payout-api-overview"}]},{"tab":"ClickPesa Payout Widgets","hidden":true,"pages":[{"title":"ClickPesa Payout Widgets","href":"/payout-widgets/payout-widgets-overview"}]},{"tab":"Plugins and SDK","pages":[{"title":"Plugins and SDK","href":"/sdk-plugins/plugins-and-extensions"}]},{"tab":"API Explorer","pages":[{"group":"AUTHORIZATION","pages":[{"title":"Generate Authorization Token","openapi":"POST /generate-token","href":"/api-reference/authorization/generate-token"}]},{"group":"USSD-PUSH","pages":[{"title":"Preview USSD-PUSH request","openapi":"POST /payments/preview-ussd-push-request","href":"/api-reference/collection/ussd-push-requests/preview-ussd-push-request"},{"title":"Initiate USSD-PUSH request","openapi":"POST /payments/initiate-ussd-push-request","href":"/api-reference/collection/ussd-push-requests/initiate-ussd-push-request"},{"title":"Query Payment Status","openapi":"GET /payments/{orderReference}","href":"/api-reference/collection/querying-for-payments/querying-for-payments"},{"title":"Query All Payments","openapi":"GET /payments/all","href":"/api-reference/collection/ussd-push-requests/query-all-payments"}]},{"group":"CARD","pages":[{"title":"Preview Card Payment","openapi":"POST /payments/preview-card-payment","href":"/api-reference/collection/card-payment/preview-card-payment"},{"title":"Initiate Card Payment","openapi":"POST /payments/initiate-card-payment","href":"/api-reference/collection/card-payment/initiate-card-payment"},{"title":"Query Payment Status","openapi":"GET /payments/{orderReference}","href":"/api-reference/collection/card-payment/querying-for-payments"},{"title":"Query All Payments","openapi":"GET /payments/all","href":"/api-reference/collection/card-payment/query-all-payments"}]},{"group":"BILLPAY","pages":[{"title":"Create Order Control Number","openapi":"POST /billpay/create-order-control-number","href":"/api-reference/collection/billpay/create-order-control-number"},{"title":"Create Customer Control Number","openapi":"POST /billpay/create-customer-control-number","href":"/api-reference/collection/billpay/create-customer-control-number"},{"title":"Bulk Create Order Control Numbers","openapi":"POST /billpay/bulk-create-order-control-numbers","href":"/api-reference/collection/billpay/bulk-create-order-control-numbers"},{"title":"Bulk Create Customer Control Numbers","openapi":"POST /billpay/bulk-create-customer-control-numbers","href":"/api-reference/collection/billpay/bulk-create-customer-control-numbers"},{"title":"Query BillPay Number Details","openapi":"GET /billpay/{billPayNumber}","href":"/api-reference/collection/billpay/querying-for-billpay-details"},{"title":"Update BillPay Reference","openapi":"PATCH /billpay/{billPayNumber}","href":"/api-reference/collection/billpay/update-billpay-reference"},{"title":"Update BillPay Number Status","openapi":"PUT /billpay/update-status","href":"/api-reference/collection/billpay/update-billpay-reference-status"}]},{"group":"CRDB DIRECT DEBIT","pages":[{"title":"Request Mandate Approval","openapi":"api-reference/collection/crdb-direct-debit/openapi.json POST /customers/crdb-direct-debit-mandate","href":"/api-reference/collection/crdb-direct-debit/request-mandate"},{"title":"Get Mandate","openapi":"api-reference/collection/crdb-direct-debit/openapi.json GET /customers/crdb-direct-debit-mandate","href":"/api-reference/collection/crdb-direct-debit/get-mandate"},{"title":"Cancel Mandate","openapi":"api-reference/collection/crdb-direct-debit/openapi.json POST /customers/crdb-direct-debit-mandate/cancel","href":"/api-reference/collection/crdb-direct-debit/cancel-mandate"}]},{"group":"MOBILE PAYOUTS","pages":[{"title":"Preview Mobile Money Payout","openapi":"POST /payouts/preview-mobile-money-payout","href":"/api-reference/disbursement/mno-payout/preview-mno-payout"},{"title":"Create Mobile Money Payout","openapi":"POST /payouts/create-mobile-money-payout","href":"/api-reference/disbursement/mno-payout/create-mno-payout"},{"title":"Query Payout Status","openapi":"GET /payouts/{orderReference}","description":"Queries for the payouts status using payout’s Order Reference","href":"/api-reference/disbursement/mno-payout/querying-for-payouts"},{"title":"Query All Payouts","openapi":"GET /payouts/all","href":"/api-reference/disbursement/mno-payout/query-all-payouts"}]},{"group":"BANK PAYOUTS","pages":[{"title":"Preview Bank Payout","openapi":"POST /payouts/preview-bank-payout","description":"Validates a bank payout and returns the fee, balance, and estimated arrival.","href":"/api-reference/disbursement/bank-payout/preview-bank-payout"},{"title":"Create Bank Payout","openapi":"POST /payouts/create-bank-payout","href":"/api-reference/disbursement/bank-payout/create-bank-payout"},{"title":"Query Payout Status","openapi":"GET /payouts/{orderReference}","href":"/api-reference/disbursement/bank-payout/querying-for-payouts"},{"title":"Query All Payouts","openapi":"GET /payouts/all","href":"/api-reference/disbursement/bank-payout/query-all-payouts"},{"title":"Retrieve Banks List","openapi":"GET /list/banks","href":"/api-reference/list/get-bank-list"}]},{"group":"LIPA NAMBA PAYOUTS","pages":[{"title":"Retrieve Lipa Namba Providers","openapi":"api-reference/disbursement/lipa-namba-payout/openapi.json GET /payouts/lipa-namba-providers","href":"/api-reference/disbursement/lipa-namba-payout/list-lipa-namba-providers"},{"title":"Preview Lipa Namba Payout","openapi":"api-reference/disbursement/lipa-namba-payout/openapi.json POST /payouts/preview-lipa-namba-payout","href":"/api-reference/disbursement/lipa-namba-payout/preview-lipa-namba-payout"},{"title":"Create Lipa Namba Payout","openapi":"api-reference/disbursement/lipa-namba-payout/openapi.json POST /payouts/create-lipa-namba-payout","href":"/api-reference/disbursement/lipa-namba-payout/create-lipa-namba-payout"},{"title":"Query Payout Status","openapi":"api-reference/disbursement/querying-for-payouts/openapi.json GET /payouts/{orderReference}","href":"/api-reference/disbursement/lipa-namba-payout/querying-for-payouts"},{"title":"Query All Payouts","openapi":"api-reference/disbursement/query-all-payouts/openapi.json GET /payouts/all","href":"/api-reference/disbursement/lipa-namba-payout/query-all-payouts"}]},{"group":"CHECKOUT LINK","pages":[{"title":"Generate Checkout Link","openapi":"POST /checkout-link/generate-checkout-url","href":"/api-reference/collection/generate-checkout-link/generate-checkout-link"}]},{"group":"PAYOUT LINK","pages":[{"title":"Generate Payout Link","openapi":"POST /payout-link/generate-payout-url","href":"/api-reference/disbursement/generate-payout-link/generate-payout-link"}]},{"group":"ACCOUNT","pages":[{"title":"Retrieve Account Balance","openapi":"GET /account/balance","href":"/api-reference/account/get-account-balance"},{"title":"Retrieve Account Statement","openapi":"GET /account/statement","href":"/api-reference/account/get-account-statement"}]},{"group":"EXCHANGE RATES","pages":[{"title":"Retrieve Exchange Rates","openapi":"GET /exchange-rates/all","href":"/api-reference/exchange/get-latest-exchange-rates"}]}]}]},"basePath":"","title":"Query All Payouts - ClickPesa Documentation","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}