Get payout status by the payoutId from your initial payout request. A list with at most one Payout is returned.This operation can be used to confirm the current status of a payout.
Short description for the transaction.
Depending on the specific MMO performing the transaction this message may be visible to the customer in the SMS receipt or within their transaction history.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PawaPay Merchant API","colors":{"primary":"#7D3CFF","light":"#C3AFFF","dark":"#7D3CFF"},"logo":{"light":"https://mintcdn.com/pawapay/Kh3dyKjADbJS5N9-/images/pawapay_logo_black.svg?fit=max\u0026auto=format\u0026n=Kh3dyKjADbJS5N9-\u0026q=85\u0026s=dcb6b0f2f8b6c6e735e80732b4b9a8a0","dark":"https://mintcdn.com/pawapay/Kh3dyKjADbJS5N9-/images/pawapay_logo_white.svg?fit=max\u0026auto=format\u0026n=Kh3dyKjADbJS5N9-\u0026q=85\u0026s=045ebe0ed432187a1da3097d6a600fd0","href":"https://pawapay.io"},"favicon":"https://mintcdn.com/pawapay/5t50YVnmXOFXUEhT/images/favicon.png?fit=max\u0026auto=format\u0026n=5t50YVnmXOFXUEhT\u0026q=85\u0026s=c97dd58d1705627ef95648764043828d","background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://dashboard.sandbox.pawapay.io","label":"Sandbox login"}],"primary":{"type":"button","label":"Create account","href":"https://dashboard.sandbox.pawapay.io/#/merchant-signup"}},"footer":{"socials":{"website":"https://pawapay.io","linkedin":"https://www.linkedin.com/company/pawapay"}},"search":{"prompt":"Search/ask from AI (MIGHT NOT BE ACCURATE) "},"fonts":{"heading":{"family":"Instrument Sans","weight":600},"body":{"family":"Instrument Sans","weight":400}},"integrations":{"clearbit":{"publicApiKey":"pk_c7e1c1e424425978e94bb81fd8af7a14"},"mixpanel":{"projectToken":"b877b7fe27113f1d7e427b2cdbe8515f","region":"eu"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Run in Postman","icon":"circle-play","href":"https://app.getpostman.com/run-collection/25129489-56cbaf62-56c2-4734-bf1f-f61d369cc9e3?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D25129489-56cbaf62-56c2-4734-bf1f-f61d369cc9e3%26entityType%3Dcollection%26workspaceId%3D8c3e7775-3da5-4bab-8a8c-ffb331ccfe27"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pawapay","hasAudioNarration":false,"actualSubdomain":"pawapay","customDomains":["docs.pawapay.io"],"gitSource":{"type":"github","owner":"pawapay","repo":"docs-hub","deployBranch":"develop","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"issues":true,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af488353de1b5eee7ab07ff","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":56},{"language":"default","tag":"API docs","count":27},{"language":"default","tag":"Dashboard Docs","count":26},{"language":"default","tag":"Payouts","count":12},{"language":"default","tag":"Introduction","count":11},{"language":"default","tag":"Finances","count":10},{"language":"default","tag":"Refunds","count":9},{"language":"default","tag":"Deposits","count":8},{"language":"default","tag":"Toolkit","count":8},{"language":"default","tag":"Overview","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"llms-txt-v2","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}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"v1/api-reference/payouts/check-payout-status","slug":"/v1/api-reference/payouts/check-payout-status","pageMetadata":{"openapi":"openapi_v1 get /payouts/{payoutId}","description":null,"title":"Check payout status","href":"/v1/api-reference/payouts/check-payout-status"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Get payout status by the `,_jsx(_components.code,{children:`payoutId`}),` from your initial payout request. A list with at most one `,_jsx(_components.code,{children:`Payout`}),` is returned.`]}),`\n`,_jsx(_components.p,{children:`This operation can be used to confirm the current status of a payout.`})]})}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":{"openapi":"openapi_v1 get /payouts/{payoutId}","description":null,"title":"Check payout status","href":"/v1/api-reference/payouts/check-payout-status"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["payouts"],"summary":"Check payout status","operationId":"getPayout","parameters":["00968e4c-d45d-4b81-80ee-e6c8b7643dbe"],"responses":{"200":"4b6ce9b7-7d91-4ebf-97e5-bf320f7f555c","400":"6506d17d-7da3-42d7-848d-613ce03ebf23","401":"97248b93-799f-45d8-8248-66b5e89017b1","403":"0a0342eb-770b-4986-9d22-2f6fd38b358a","500":"e58da912-8687-4a2c-a71e-fa3ee79e9589"},"method":"get","type":"path","servers":["321c7a20-9195-42cf-bd7e-d3f33a9abfd1","0a99643b-f413-409a-af4c-2db4372b65d3"],"security":["38397491-e1d3-47bd-a29e-385725b84bce"],"path":"/payouts/{payoutId}","baseUrlOptions":["https://api.sandbox.pawapay.io","https://api.pawapay.io"],"title":"Check payout status","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"00968e4c-d45d-4b81-80ee-e6c8b7643dbe":{"name":"payoutId","in":"path","description":"The `payoutId` of the payout you want to check the status of.","required":true,"style":"simple","explode":false,"schema":{"minLength":36,"maxLength":36,"type":"string","format":"uuid","isRequired":true,"description":"The `payoutId` of the payout you want to check the status of.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"4b6ce9b7-7d91-4ebf-97e5-bf320f7f555c":{"description":"Request has been processed by PawaPay","content":{"application/json":{"schema":{"type":"array","items":{"required":["payoutId","status","amount","currency","country","correspondent","recipient","customerTimestamp","created"],"type":"object","properties":{"payoutId":{"minLength":36,"maxLength":36,"type":"string","format":"uuid","description":"The payoutId which was used to initiate this payout.","example":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","isRequired":true,"uniqueKey":"items.[INDEX].payoutId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Possible payout statuses: \n* `ACCEPTED` - The payout request has been **accepted** by PawaPay for processing. \n* `ENQUEUED` - The payout request has been **accepted**, but has been enqueued for processing later. Read more about [enqueued payouts](/payouts#enqueued-payouts). \n* `SUBMITTED` - The payout request has been submitted to the MMO and is being processed.\n* `COMPLETED` - The payout request has been successfully processed. This is a **Final state.**\n* `FAILED` - The payout request has been processed, but failed. **Final state.**\n","enum":["ACCEPTED","SUBMITTED","ENQUEUED","COMPLETED","FAILED"],"isRequired":true,"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"amount":{"minLength":1,"maxLength":23,"type":"string","pattern":"^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$","description":"The amount to be collected (deposit) or disbursed (payout or refund). \n\nAmount must follow below requirements or the request will be **rejected**:\n* Between zero and two decimal places can be supplied, depending on what the specific MMO supports. Learn about all [MMO supported decimal places](/using_the_api#correspondents).\n* The minimum and maximum amount depends on the limits of the specific MMO. You can find them from the [Active Configuration](/v1/api-reference/toolkit/active-configuration) endpoint.\n* Leading zeroes are not permitted except where the value is less than 1. For any value less than one, one and only one leading zero must be supplied.\n* Trailing zeroes are permitted.\n\nValid examples:\n`5`, `5.0`, `5.00`, `5.5`, `5.55`, `5555555`, `0.5`\n\nNot valid examples:\n`5.`, `5.555`, `5555555555555555555`, `.5`, `-5.5`, `00.5`, `00.00`, `00001.32`\n","example":"15","isRequired":true,"uniqueKey":"items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","description":"The currency in which the `amount` is specified.\n\nFormat must be the ISO 4217 three character currency code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\nYou can find all the supported currencies that the specific `correspondent` supports [from here](/using_the_api#correspondents).\n\nThe [active configuration](/v1/api-reference/toolkit/active-configuration) endpoint provides the list of correspondents configured for your account together with the currencies.\n","example":"ZMW","isRequired":true,"uniqueKey":"items.[INDEX].currency","typeLabel":"string"},"country":{"type":"string","description":"The country in which the MMO operates. \n\nFormat is ISO 3166-1 alpha-3, three character country code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements).\n","example":"ZMB","isRequired":true,"uniqueKey":"items.[INDEX].country","typeLabel":"string"},"correspondent":{"type":"string","description":"The correspondent code refers to the specific MMO that the specified phone number (MSISDN) has an active mobile money wallet with. \n\nYou can find all the supported correspondents [listed here](/using_the_api#correspondents). \n\nThe [active configuration](/v1/api-reference/toolkit/active-configuration) endpoint provides the list of correspondents configured for your account.\n\nYou can use the [predict correspondent](/v1/api-reference/toolkit/predict-correspondent) enpoint to predict the correct correspondent to use based on the phone number (MSISDN).\n","example":"MTN_MOMO_ZMB","isRequired":true,"uniqueKey":"items.[INDEX].correspondent","typeLabel":"string"},"recipient":{"required":["address","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of financial address. At the moment, only **MSISDN** is supported as the financial address. ","example":"MSISDN","enum":["MSISDN"],"isRequired":true,"uniqueKey":"items.[INDEX].recipient.type","typeLabel":"enum\u003cstring>"},"address":{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The phone number (MSISDN) of the payer or recipient.\nThe format is described in [Wikipedia](https://en.wikipedia.org/wiki/MSISDN). \n\nMSISDN validation has following rules:\n * Only digits without whitespaces or any other separators or prefixes like '+'.\n * Should not start with zero.\n * Country code is mandatory.\n * Should not exceed or be less than the valid length of specified country.\n \n Valid examples for Zambia:\n `260763456789`\n \n Not valid examples for Zambia:\n `+260763456789`, `260 763 456789`, `260-7634-56789`, `0260763456789`, `2607634567`, `260763456789543`, `999558708954`, `37255870895`\n","example":"260763456789","isRequired":true,"uniqueKey":"items.[INDEX].recipient.address.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"items.[INDEX].recipient.address","typeLabel":"object"}},"description":"The phone number (MSISDN) of the recipient or payer must be specified as the `value` of the `address`.","isRequired":true,"uniqueKey":"items.[INDEX].recipient","typeLabel":"object"},"customerTimestamp":{"type":"string","description":"The timestamp for when you initiated the payout process. Format defined by 'date-time' in RFC3339 section 5.6 from [IETF](https://tools.ietf.org/html/rfc3339#section-5.6).","format":"date-time","example":"2020-02-21T17:32:28Z","isRequired":true,"uniqueKey":"items.[INDEX].customerTimestamp","typeLabel":"string\u003cdate-time>"},"created":{"type":"string","description":"The timestamp of when the payout was created in the PawaPay platform. Format defined by 'date-time' in RFC3339 section 5.6 from [IETF](https://tools.ietf.org/html/rfc3339#section-5.6).","format":"date-time","example":"2020-02-21T17:32:29Z","isRequired":true,"uniqueKey":"items.[INDEX].created","typeLabel":"string\u003cdate-time>"},"statementDescription":{"minLength":4,"maxLength":22,"type":"string","pattern":"^[a-zA-Z0-9 ]+$","description":"Short description for the transaction. \nDepending on the specific MMO performing the transaction this message may be visible to the customer in the SMS receipt or within their transaction history.\n\nMust be between **4 and 22 alphanumeric characters**.\n","example":"Note of 4 to 22 chars","uniqueKey":"items.[INDEX].statementDescription","typeLabel":"string"},"receivedByRecipient":{"type":"string","description":"When the payment was received by the recipient. Format defined by 'date-time' in RFC3339 section 5.6 from [IETF](https://tools.ietf.org/html/rfc3339#section-5.6).","format":"date-time","example":"2020-02-21T17:32:30Z","uniqueKey":"items.[INDEX].receivedByRecipient","typeLabel":"string\u003cdate-time>"},"correspondentIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"items.[INDEX].correspondentIds.additionalProperties","typeLabel":"string"},"description":"The unique ID for this financial transaction assigned by the MMO.","example":{"MTN_INIT":"ABC123","MTN_FINAL":"DEF456"},"uniqueKey":"items.[INDEX].correspondentIds","typeLabel":"object"},"failureReason":{"required":["failureCode"],"type":"object","properties":{"failureCode":{"type":"string","description":"Possible payout failure codes: \n* `BALANCE_INSUFFICIENT` - The PawaPay wallet balance is insufficient to proceed with the payout. \n* `RECIPIENT_NOT_FOUND` - The financial address (phone number) specified as the recipient does not belong to the MMO specified as the correspondent. \n* `RECIPIENT_NOT_ALLOWED_TO_RECEIVE` - The recipient has reached a limit on their wallet that stops them from being able to accept this payout. \n* `MANUALLY_CANCELLED` - The payout request was enqueued and subsequently cancelled from the PawaPay Dashboard or through the [Cancel Enqueued Payout](/v1/api-reference/payouts/cancel-enqueued-payout) endpoint.\n* `OTHER_ERROR` - Any other error. Please refer to `failureMessage`.\n","example":"OTHER_ERROR","enum":["BALANCE_INSUFFICIENT","RECIPIENT_NOT_FOUND","RECIPIENT_NOT_ALLOWED_TO_RECEIVE","MANUALLY_CANCELLED","OTHER_ERROR"],"isRequired":true,"uniqueKey":"items.[INDEX].failureReason.failureCode","typeLabel":"enum\u003cstring>"},"failureMessage":{"type":"string","description":"Additional optional failure message","example":"Recipient's address is blocked","uniqueKey":"items.[INDEX].failureReason.failureMessage","typeLabel":"string"}},"uniqueKey":"items.[INDEX].failureReason","typeLabel":"object"},"metadata":{"description":"The metadata that was provided in the original initation request in a JSON object format.\n","type":"object","properties":{"value of fieldName":{"type":"string","description":"Each passed in metadata field will be a property of the metadata JSON object. The key will be the 'fieldName' and the value will be 'fieldValue'.","uniqueKey":"items.[INDEX].metadata.value of fieldName","typeLabel":"string"}},"example":{"orderId":"ORD-123456789","customerId":"customer@email.com"},"uniqueKey":"items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"COMPLETED":{"title":"COMPLETED","value":[{"payoutId":"8917c345-4791-4285-a416-62f24b6982db","status":"COMPLETED","amount":"123.45","currency":"ZMW","country":"ZMB","correspondent":"MTN_MOMO_ZMB","recipient":{"type":"MSISDN","address":{"value":"260763456789"}},"customerTimestamp":"2020-10-19T08:17:00Z","statementDescription":"From ACME company","created":"2020-10-19T08:17:01Z","receivedByRecipient":"2020-10-19T08:17:02Z","correspondentIds":{"SOME_CORRESPONDENT_ID":"12356789"},"metadata":{"orderId":"ORD-123456789","customerId":"customer@email.com"}}]},"ACCEPTED":{"title":"ACCEPTED","value":[{"payoutId":"8917c345-4791-4285-a416-62f24b6982db","status":"ACCEPTED","amount":"123.45","currency":"ZMW","country":"ZMB","correspondent":"MTN_MOMO_ZMB","recipient":{"type":"MSISDN","address":{"value":"260763456789"}},"customerTimestamp":"2020-10-19T08:17:00Z","statementDescription":"From ACME company","created":"2020-10-19T08:17:01Z","metadata":{"orderId":"ORD-123456789","customerId":"customer@email.com"}}]},"ENQUEUED":{"title":"ENQUEUED","value":[{"payoutId":"8917c345-4791-4285-a416-62f24b6982db","status":"ENQUEUED","amount":"123.45","currency":"ZMW","country":"ZMB","correspondent":"MTN_MOMO_ZMB","recipient":{"type":"MSISDN","address":{"value":"260763456789"}},"customerTimestamp":"2020-10-19T08:17:00Z","statementDescription":"From ACME company","created":"2020-10-19T08:17:01Z","metadata":{"orderId":"ORD-123456789","customerId":"customer@email.com"}}]},"SUBMITTED":{"title":"SUBMITTED","value":[{"payoutId":"8917c345-4791-4285-a416-62f24b6982db","status":"SUBMITTED","amount":"123.45","currency":"ZMW","country":"ZMB","correspondent":"MTN_MOMO_ZMB","recipient":{"type":"MSISDN","address":{"value":"260763456789"}},"customerTimestamp":"2020-10-19T08:17:00Z","statementDescription":"From ACME company","created":"2020-10-19T08:17:01Z","metadata":{"orderId":"ORD-123456789","customerId":"customer@email.com"}}]},"FAILED":{"title":"FAILED","value":[{"payoutId":"8917c345-4791-4285-a416-62f24b6982db","status":"FAILED","amount":"123.45","currency":"ZMW","country":"ZMB","correspondent":"MTN_MOMO_ZMB","recipient":{"type":"MSISDN","address":{"value":"260973456789"}},"customerTimestamp":"2020-10-19T08:17:00Z","statementDescription":"From ACME company","created":"2020-10-19T08:17:01Z","failureReason":{"failureCode":"RECIPIENT_NOT_FOUND","failureMessage":"Recipient not found"},"metadata":{"orderId":"ORD-123456789","customerId":"customer@email.com"}}]},"Payout Not Found":{"title":"Payout Not Found","value":[]}},"exampleType":"examples"}},"exampleType":"examples"},"6506d17d-7da3-42d7-848d-613ce03ebf23":{"description":"Request was rejected due to incompatibility with PawaPay API specification","content":{"application/json":{"schema":{"required":["errorId","errorCode","errorMessage"],"type":"object","properties":{"errorId":{"maxLength":36,"type":"string","description":"A unique error ID in the PawaPay platform.","example":"63743264-7292-11ea-bc55-0242ac130003","isRequired":true,"uniqueKey":"errorId","typeLabel":"string"},"errorCode":{"type":"integer","description":"PawaPay internal error code.","example":1,"isRequired":true,"uniqueKey":"errorCode","typeLabel":"integer"},"errorMessage":{"type":"string","description":"Error message.","example":"Internal error","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Mandatory Field Missing":{"title":"Mandatory Field Missing","value":{"errorId":"4f0d5e13-7e88-4cc6-827c-8c0640dc2cd3","errorCode":1,"errorMessage":"Invalid input"}}},"exampleType":"examples"}},"exampleType":"examples"},"97248b93-799f-45d8-8248-66b5e89017b1":{"description":"Authentication Failure. Please check your authentication token","content":{"application/json":{"schema":{"required":["errorId","errorCode","errorMessage"],"type":"object","properties":{"errorId":{"maxLength":36,"type":"string","description":"A unique error ID in the PawaPay platform.","example":"63743264-7292-11ea-bc55-0242ac130003","isRequired":true,"uniqueKey":"errorId","typeLabel":"string"},"errorCode":{"type":"integer","description":"PawaPay internal error code.","example":1,"isRequired":true,"uniqueKey":"errorCode","typeLabel":"integer"},"errorMessage":{"type":"string","description":"Error message.","example":"Internal error","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Authentication Failure":{"title":"Authentication Failure","value":{"errorId":"cad1529e-040b-4c9d-a21d-2ba3056ff750","errorCode":2,"errorMessage":"Authentication error"}}},"exampleType":"examples"}},"exampleType":"examples"},"0a0342eb-770b-4986-9d22-2f6fd38b358a":{"description":"Authorization Failure. Please check your authentication token","content":{"application/json":{"schema":{"required":["errorId","errorCode","errorMessage"],"type":"object","properties":{"errorId":{"maxLength":36,"type":"string","description":"A unique error ID in the PawaPay platform.","example":"63743264-7292-11ea-bc55-0242ac130003","isRequired":true,"uniqueKey":"errorId","typeLabel":"string"},"errorCode":{"type":"integer","description":"PawaPay internal error code.","example":1,"isRequired":true,"uniqueKey":"errorCode","typeLabel":"integer"},"errorMessage":{"type":"string","description":"Error message.","example":"Internal error","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Authorization Failure":{"title":"Authorization Failure","value":{"errorId":"daa495f0-541d-4192-b636-a8877b25a510","errorCode":3,"errorMessage":"Authorization error"}}},"exampleType":"examples"}},"exampleType":"examples"},"e58da912-8687-4a2c-a71e-fa3ee79e9589":{"description":"Internal Server Error","content":{"application/json":{"schema":{"required":["errorId","errorCode","errorMessage"],"type":"object","properties":{"errorId":{"maxLength":36,"type":"string","description":"A unique error ID in the PawaPay platform.","example":"63743264-7292-11ea-bc55-0242ac130003","isRequired":true,"uniqueKey":"errorId","typeLabel":"string"},"errorCode":{"type":"integer","description":"PawaPay internal error code.","example":1,"isRequired":true,"uniqueKey":"errorCode","typeLabel":"integer"},"errorMessage":{"type":"string","description":"Error message.","example":"Internal error","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"System Error":{"title":"System Error","value":{"errorId":"d428a89e-fa8b-42b8-ba20-68be20d50af1","errorCode":0,"errorMessage":"Internal error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"38397491-e1d3-47bd-a29e-385725b84bce":{"bearerAuth":{"type":"http","description":"See [Authentication](/using_the_api#authentication).","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"321c7a20-9195-42cf-bd7e-d3f33a9abfd1":{"url":"https://api.sandbox.pawapay.io","description":"PawaPay Merchant API sandbox"},"0a99643b-f413-409a-af4c-2db4372b65d3":{"url":"https://api.pawapay.io","description":"PawaPay Merchant API production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"See [Authentication](/using_the_api#authentication).","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"See [Authentication](/using_the_api#authentication).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"v1/api-reference/openapi_v1.yaml"},"subdomain":"pawapay","siteName":"PawaPay Merchant API","title":"Check payout status - PawaPay Merchant API","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/api-reference/payouts/check-payout-status","matchLevel":1},"v1":{"href":"/v1/api-reference/payouts/check-payout-status","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T13:42:35.088Z","originalFileLocation":"v1/api-reference/payouts/check-payout-status.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=\"application-name\" content=\"PawaPay Merchant API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pawapay/1ir90k4Vxmsj1N5e/_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/pawapay/1ir90k4Vxmsj1N5e/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pawapay/1ir90k4Vxmsj1N5e/_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/pawapay/1ir90k4Vxmsj1N5e/_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/pawapay/1ir90k4Vxmsj1N5e/_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/pawapay/1ir90k4Vxmsj1N5e/_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/pawapay/1ir90k4Vxmsj1N5e/_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/pawapay/1ir90k4Vxmsj1N5e/_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/pawapay/1ir90k4Vxmsj1N5e/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Check payout status - PawaPay Merchant API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PawaPay Merchant API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pawapay.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Check+payout+status\u0026amp;theme=6df4a9d744128cd68aba8e91\u0026amp;signature=e5c97ff89731ed81b8912290bee4776450b8d172dcb6c58c18d0177b2e75984b\">\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=\"Check payout status - PawaPay Merchant API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pawapay.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Check+payout+status\u0026amp;theme=6df4a9d744128cd68aba8e91\u0026amp;signature=e5c97ff89731ed81b8912290bee4776450b8d172dcb6c58c18d0177b2e75984b\">\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/pawapay/1ir90k4Vxmsj1N5e/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PawaPay Merchant API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7D3CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/api-reference/payouts/check-payout-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pawapay.io/#organization\",\"name\":\"PawaPay Merchant API\",\"url\":\"https://docs.pawapay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pawapay/Kh3dyKjADbJS5N9-/images/pawapay_logo_black.svg?fit=max\u0026auto=format\u0026n=Kh3dyKjADbJS5N9-\u0026q=85\u0026s=dcb6b0f2f8b6c6e735e80732b4b9a8a0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pawapay.io#website\",\"name\":\"PawaPay Merchant API\",\"url\":\"https://docs.pawapay.io\",\"publisher\":{\"@id\":\"https://docs.pawapay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status#webpage\",\"url\":\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status\",\"name\":\"Check payout status\",\"dateModified\":\"2026-10-28T13:42:35.088Z\",\"isPartOf\":{\"@id\":\"https://docs.pawapay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payouts\",\"item\":\"https://docs.pawapay.io/v1/api-reference/payouts/request-payout\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Check payout status\",\"item\":\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status#apireference\",\"headline\":\"Check payout status\",\"name\":\"Check payout status\",\"url\":\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pawapay.io/v1/api-reference/payouts/check-payout-status#webpage\"},\"dateModified\":\"2026-10-28T13:42:35.088Z\",\"publisher\":{\"@id\":\"https://docs.pawapay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pawapay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PawaPay Merchant API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PawaPay Merchant API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v1/api-reference/payouts/check-payout-status.md","siteName":"PawaPay Merchant API","nav":{"global":{"anchors":[{"anchor":"Run in Postman","icon":"circle-play","href":"https://app.getpostman.com/run-collection/25129489-56cbaf62-56c2-4734-bf1f-f61d369cc9e3?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D25129489-56cbaf62-56c2-4734-bf1f-f61d369cc9e3%26entityType%3Dcollection%26workspaceId%3D8c3e7775-3da5-4bab-8a8c-ffb331ccfe27"}]},"versions":[{"version":"v2","pages":[{"title":"v2","href":"/v2/api-reference/payouts/check-payout-status"}]},{"version":"v1","tabs":[{"tab":"API docs","pages":[{"title":"API docs","href":"/getting_started"}]},{"tab":"API Reference","groups":[{"group":"Deposits","pages":[{"openapi":"openapi_v1 post /deposits","title":"Request deposit","href":"/v1/api-reference/deposits/request-deposit"},{"openapi":"openapi_v1 get /deposits/{depositId}","title":"Check deposit status","href":"/v1/api-reference/deposits/check-deposit-status"},{"openapi":"openapi_v1 post /deposits/resend-callback","title":"Resend deposit callback","href":"/v1/api-reference/deposits/resend-deposit-callback"},{"title":"Deposit callback","icon":"webhook","href":"/v1/api-reference/deposits/deposit-callback"}]},{"group":"Payouts","pages":[{"openapi":"openapi_v1 post /payouts","description":null,"title":"Request payout","href":"/v1/api-reference/payouts/request-payout"},{"openapi":"openapi_v1 get /payouts/{payoutId}","title":"Check payout status","href":"/v1/api-reference/payouts/check-payout-status"},{"openapi":"openapi_v1 post /payouts/resend-callback","description":null,"title":"Resend payout callback","href":"/v1/api-reference/payouts/resend-payout-callback"},{"openapi":"openapi_v1 post /payouts/fail-enqueued/{payoutId}","title":"Cancel enqueued payout","href":"/v1/api-reference/payouts/cancel-enqueued-payout"},{"openapi":"openapi_v1 post /payouts/bulk","title":"Request bulk payout","href":"/v1/api-reference/payouts/request-bulk-payout"},{"title":"Payout callback","icon":"webhook","href":"/v1/api-reference/payouts/payout-callback"}]},{"group":"Refunds","pages":[{"openapi":"openapi_v1 post /refunds","title":"Request refund","href":"/v1/api-reference/refunds/request-refund"},{"openapi":"openapi_v1 get /refunds/{refundId}","title":"Check refund status","href":"/v1/api-reference/refunds/check-refund-status"},{"openapi":"openapi_v1 post /refunds/resend-callback","title":"Resend refund callback","href":"/v1/api-reference/refunds/resend-refund-callback"},{"title":"Refund callback","icon":"webhook","href":"/v1/api-reference/refunds/refund-callback"}]},{"group":"Payment page","pages":[{"openapi":"openapi_v1 post /v1/widget/sessions","title":"Deposit via Payment Page","href":"/v1/api-reference/payment-page/deposit-via-payment-page"}]},{"group":"Wallet balances","pages":[{"openapi":"openapi_v1 get /v1/wallet-balances","title":"Wallet balances","href":"/v1/api-reference/wallet-balances/wallet-balances"},{"openapi":"openapi_v1 get /v1/wallet-balances/{country}","title":"Wallet balances for country","href":"/v1/api-reference/wallet-balances/wallet-balances-for-country"}]},{"group":"Toolkit","pages":[{"openapi":"openapi_v1 get /active-conf","title":"Active Configuration","href":"/v1/api-reference/toolkit/active-configuration"},{"openapi":"openapi_v1 get /availability","title":"Correspondent Availability","href":"/v1/api-reference/toolkit/availability"},{"openapi":"openapi_v1 post /v1/predict-correspondent","title":"Predict Correspondent","href":"/v1/api-reference/toolkit/predict-correspondent"},{"openapi":"openapi_v1 get /public-key/http","title":"Public Keys","href":"/v1/api-reference/toolkit/public-keys"}]}]},{"tab":"Dashboard Docs","pages":[{"title":"Dashboard Docs","href":"/dashboard/introduction"}]}]}]},"basePath":"","title":"Check payout status - PawaPay Merchant API","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}