Follow the step-by-step guide on how to build a payment flow using payouts.
This API call is idempotent, which means it is safe to submit a request with the same payoutId multiple times.
Duplicate requests with the same payoutId will be ignored with the DUPLICATE_IGNORED status in the response.
Since the request can be rejected, you must check the status code in the response for each submitted request. The failureReason in the response will contain information about the reason of the rejection.
Each request can get one of the statuses on initiation:
Status
Description
ACCEPTED
Yes
The payout has been accepted by PawaPay for processing.
REJECTED
No
The payout has been rejected. See failureReason for details.
DUPLICATE_IGNORED
No
The payout has been ignored as a duplicate of an already accepted payout. Duplication logic relies upon payoutId.
A UUIDv4 based unique ID for this payment.
We require you to provide the unique ID for all initiated payments to ensure you can always reconcile all payments.
Please store this ID in your system before initiating the payment with PawaPay.
A short narration for the transaction.
Depending on the 'provider', this message may be visible to the customer in the SMS receipt or within their transaction history.
Defaults to your company name as registered on your PawaPay account trimmed to fit the length limitations.
A list of metadata that you can attach to the payment for providing additional context about the payment.
For example, adding the channel from which the payment was initated, product ID or anything else that might help your operations team.
Metadata will be included in:
In the dashboard on payment details pages
Financial statements as JSON object
Callbacks
Metadata can be used when searching in the PawaPay Dashboard.
Full value of the metadata field must be used for searches.
Metadata will not be visible to the customer that is involved in this payment.
Up to 10 metadata fields can be attached to a payment.
A UUIDv4 based unique ID for this payment.
We require you to provide the unique ID for all initiated payments to ensure you can always reconcile all payments.
Please store this ID in your system before initiating the payment with PawaPay.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ae1fbb88a46f6fe5a230449","collectionId":"9d19457a-cc42-4d1f-87b4-bc21adfd4fdd","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae1fbb88a46f6fe5a230449"},"feedback":{"issues":true,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1fbb88a46f6fe5a230449","clientVersion":"0.0.4043","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":"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"v2/api-reference/payouts/initiate-payout","slug":"/v2/api-reference/payouts/initiate-payout","pageMetadata":{"openapi":"openapi_v2 post /v2/payouts","description":null,"title":"Initiate payout","href":"/v2/api-reference/payouts/initiate-payout"},"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={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,Info,Table,Tooltip}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tooltip)_missingMdxReference(`Tooltip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The payout endpoint allows you to pay a customer.`}),`\n`,_jsx(Card,{title:`Check the guide!`,icon:`readme`,href:`/v2/docs/payouts`,horizontal:`true`,children:_jsx(_components.p,{children:`Follow the step-by-step guide on how to build a payment flow using payouts.`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`This API call is `,_jsx(`em`,{children:`idempotent`}),`, which means it is safe to submit a request with the same `,_jsx(_components.code,{children:`payoutId`}),` multiple times.`]}),`\n`,_jsxs(_components.li,{children:[`Duplicate requests with the same `,_jsx(_components.code,{children:`payoutId`}),` will be ignored with the `,_jsx(_components.code,{children:`DUPLICATE_IGNORED`}),` status in the response.`]}),`\n`,_jsxs(_components.li,{children:[`Since the request can be rejected, you must check the `,_jsx(_components.code,{children:`status`}),` code in the response for each submitted request. The `,_jsx(_components.code,{children:`failureReason`}),` in the response will contain information about the reason of the rejection.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Each request can get one of the statuses on initiation:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:_jsx(Tooltip,{tip:`Will a callback be sent for this payout?`,children:`Callback`})}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ACCEPTED`})}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`The payout has been `,_jsx(_components.strong,{children:`accepted`}),` by PawaPay for processing.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`REJECTED`})}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`The payout has been `,_jsx(_components.strong,{children:`rejected`}),`. See `,_jsx(_components.code,{children:`failureReason`}),` for details.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`DUPLICATE_IGNORED`})}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`The payout has been `,_jsx(_components.strong,{children:`ignored`}),` as a duplicate of an already accepted payout. Duplication logic relies upon `,_jsx(_components.code,{children:`payoutId`}),`.`]})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`how-to-find-out-the-final-status-of-this-payout`,children:`How to find out the final status of this payout?`}),`\n`,_jsxs(_components.p,{children:[`As the PawaPay Merchant API is an `,_jsx(_components.a,{href:`/v2/docs/what_to_know#callbacks`,children:`asynchronous API`}),`, you can find out the final status of the `,_jsx(_components.code,{children:`ACCEPTED`}),` payout by either:`]}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Waiting for a callback`,icon:`webhook`,href:`/v2/api-reference/payouts/payout-callback`,horizontal:`true`,children:_jsx(_components.p,{children:`If you have configured callbacks, the callback with the final status of the payout will be delivered to your callback URL.`})}),_jsx(Card,{title:`Checking the status`,icon:`code-compare`,href:`/v2/api-reference/payouts/check-payout-status`,horizontal:`true`,children:_jsxs(_components.p,{children:[`Or poll the `,_jsx(_components.code,{children:`Check Payout Status`}),` endpoint.`]})})]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Headers related to `,_jsx(_components.a,{href:`/v2/docs/signatures`,children:`signatures`}),` must only be included if you have enabled “Only accept signed requests”.\nRead more about it from the `,_jsx(_components.a,{href:`/dashboard/other/system_conf/api_tokens#signed-requests`,children:`PawaPay Dashboard documentation`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"openapi_v2 post /v2/payouts","description":null,"title":"Initiate payout","href":"/v2/api-reference/payouts/initiate-payout"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"How to find out the final status of this payout?","slug":"how-to-find-out-the-final-status-of-this-payout","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["payouts"],"summary":"Initiate payout","operationId":"createPayout","parameters":["7b0101a6-a756-4867-b0ad-2b2f50b44609","9989f058-9486-4ba5-8c35-0086935bc44f","d8b4d444-1e06-4eef-b0b7-9cdcd5a52717","0b5b254c-f347-4fcf-8bd6-6cfebd790bc3","1a85697c-3ad8-4668-ab41-77d7f48e6295"],"requestBody":"0c08d9b4-689a-4a15-b9f9-a376f30f4a41","responses":{"200":"80458893-81be-4eec-8d79-b4879bda108e","400":"36c669b1-2105-47c8-a510-99ba940e2a5d","401":"00ba1066-adfc-4f71-aeb7-fc75c64092a7","403":"81973dbb-949c-442d-920b-fd2c0d6d21f3","500":"0d34cc32-3d96-4de0-aae6-65a19e488e20"},"method":"post","type":"path","servers":["332d3246-544a-43e8-a048-d892bbfd6c56","b2edd67b-6644-48f0-ad04-0671ca7dc003"],"security":["b5c32e51-470f-4ecf-869d-e12b6610cbf5"],"path":"/v2/payouts","baseUrlOptions":["https://api.sandbox.pawapay.io","https://api.pawapay.io"],"title":"Initiate payout","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7b0101a6-a756-4867-b0ad-2b2f50b44609":{"in":"header","name":"Content-Digest","schema":{"type":"string","format":"string","description":"SHA-256 or SHA-512 hash of the request body.","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cstring>"},"required":false},"9989f058-9486-4ba5-8c35-0086935bc44f":{"in":"header","name":"Signature","schema":{"type":"string","format":"string","description":"Signature of the request according to [RFC-9421](https://datatracker.ietf.org/doc/rfc9421/).","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cstring>"},"required":false},"d8b4d444-1e06-4eef-b0b7-9cdcd5a52717":{"in":"header","name":"Signature-Input","schema":{"type":"string","format":"string","description":"Signature input according to [RFC-9421](https://datatracker.ietf.org/doc/rfc9421/).","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cstring>"},"required":false},"0b5b254c-f347-4fcf-8bd6-6cfebd790bc3":{"in":"header","name":"Accept-Signature","schema":{"type":"string","format":"string","description":"Expected signature algorithm of the response according to [RFC-9421](https://datatracker.ietf.org/doc/rfc9421/).","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cstring>"},"required":false},"1a85697c-3ad8-4668-ab41-77d7f48e6295":{"in":"header","name":"Accept-Digest","schema":{"type":"string","format":"string","description":"Expected digest algorithm of the response according to [RFC-9421](https://datatracker.ietf.org/doc/rfc9421/).","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cstring>"},"required":false}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","currency","payoutId","recipient"],"properties":{"payoutId":{"minLength":36,"maxLength":36,"type":"string","format":"uuid","description":"A UUIDv4 based unique ID for this payment. \nWe require you to provide the unique ID for all initiated payments to ensure you can always reconcile all payments.\nPlease store this ID in your system before initiating the payment with PawaPay.\n","example":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","isRequired":true,"uniqueKey":"payoutId","typeLabel":"string\u003cuuid>"},"recipient":{"description":"Details about the customer who is paying or receiving the payment.","required":["type","accountDetails"],"type":"object","properties":{"type":{"type":"string","description":"The type of account involved in the transaction. At the moment, only **MMO** is supported.","example":"MMO","enum":["MMO"],"isRequired":true,"uniqueKey":"recipient.type","typeLabel":"enum\u003cstring>"},"accountDetails":{"required":["provider","phoneNumber"],"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number (MSISDN) of the customer paying or receiving payment.\nThe format is described in [Wikipedia](https://en.wikipedia.org/wiki/MSISDN). \n\nUse [predict provider](/v2/api-reference/toolkit/predict-provider) to validate and sanitise the phone number.\n\nPhone number 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","example":"260763456789","isRequired":true,"uniqueKey":"recipient.accountDetails.phoneNumber","typeLabel":"string"},"provider":{"type":"string","description":"The provider represents the mobile money operator or processor that can process payments.\n\nFind here a list of all the supported [providers](/v2/docs/providers). \n\nThe [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint provides the list of provider configured for your account.\n\nYou can use the [predict provider](/v2/api-reference/toolkit/predict-provider) enpoint to predict the provider to use based on the phone number (MSISDN).\n","example":"MTN_MOMO_ZMB","isRequired":true,"uniqueKey":"recipient.accountDetails.provider","typeLabel":"string"}},"isRequired":true,"uniqueKey":"recipient.accountDetails","typeLabel":"object"}},"isRequired":true,"uniqueKey":"recipient","typeLabel":"object"},"amount":{"minLength":1,"maxLength":23,"type":"string","pattern":"^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$","description":"The amount of the payment.\n\nAmount must follow below requirements or the request will be **rejected**:\n* Not all providers support decimals. Find which ones do from [providers](/v2/docs/providers) or dynamically using [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint.\n* Transaction limits apply. Find them from the [Active Configuration](/v2/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","example":"15","isRequired":true,"uniqueKey":"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\nFind the supported currencies for the [provider](/v2/docs/providers).\n\nThe [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint has all the providers configured for your account together with the supported currencies.\n","example":"ZMW","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"clientReferenceId":{"type":"string","description":"A reference to an entity in your system that this payment relates to. For example, an invoice ID, customer ID etc.","example":"INV-123456","uniqueKey":"clientReferenceId","typeLabel":"string"},"customerMessage":{"minLength":4,"maxLength":22,"type":"string","pattern":"^[a-zA-Z0-9 ]+$","description":"A short narration for the transaction. \nDepending on the 'provider', this message may be visible to the customer in the SMS receipt or within their transaction history.\n\nDefaults to your company name as registered on your PawaPay account trimmed to fit the length limitations.\n","example":"Note of 4 to 22 chars","uniqueKey":"customerMessage","typeLabel":"string"},"metadata":{"description":"A list of metadata that you can attach to the payment for providing additional context about the payment.\nFor example, adding the channel from which the payment was initated, product ID or anything else that might help your operations team.\n\nMetadata will be included in:\n- In the dashboard on payment details pages\n- Financial statements as JSON object \n- Callbacks\n\nMetadata can be used when searching in the PawaPay Dashboard. \nFull value of the metadata field must be used for searches.\n\nMetadata will not be visible to the customer that is involved in this payment. \n\nUp to 10 metadata fields can be attached to a payment.\n","type":"array","items":{"type":"object","properties":{"additionalProperties":{"type":"string","description":"The metadata that you are attaching to the payment. For example `\"orderId\":\"ORD-123456789\"`.","example":"\"orderId\": \"ORD-123456789\"","uniqueKey":"metadata.items.[INDEX].\\additionalProperties","typeLabel":"string"},"isPII":{"type":"boolean","default":false,"description":"Indicates whether the field contains personally identifiable information. Used for compliance with GDPR or other relevant data privacy laws.","example":true,"uniqueKey":"metadata.items.[INDEX].isPII","typeLabel":"boolean"}},"example":[{"orderId":"ORD-123456789"},{"customerId":"customer@email.com","isPII":true}],"uniqueKey":"metadata.items.[INDEX]","typeLabel":"object"},"example":[{"orderId":"ORD-123456789"},{"customerId":"customer@email.com","isPII":true}],"uniqueKey":"metadata","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","recipient":{"type":"MMO","accountDetails":{"phoneNumber":"260763456789","provider":"MTN_MOMO_ZMB"}},"amount":"15","currency":"ZMW","clientReferenceId":"INV-123456","customerMessage":"Note of 4 to 22 chars","metadata":[{"orderId":"ORD-123456789"},{"customerId":"customer@email.com","isPII":true}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"80458893-81be-4eec-8d79-b4879bda108e":{"description":"Request has been accepted for processing by PawaPay","content":{"application/json":{"schema":{"required":["payoutId","status"],"type":"object","properties":{"payoutId":{"minLength":36,"maxLength":36,"type":"string","format":"uuid","description":"A UUIDv4 based unique ID for this payment. \nWe require you to provide the unique ID for all initiated payments to ensure you can always reconcile all payments.\nPlease store this ID in your system before initiating the payment with PawaPay.\n","example":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","isRequired":true,"uniqueKey":"payoutId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"The initiation status of the payout: \n* `ACCEPTED` - The payout has been **accepted** by PawaPay for processing.\n* `REJECTED` - The payout request has been **rejected** by PawaPay. See failureReason for details. \n* `DUPLICATE_IGNORED` - The payout has been **ignored** as a duplicate of and already accepted payout. Deduplication is based on `payoutId`.\n","enum":["ACCEPTED","REJECTED","DUPLICATE_IGNORED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created":{"type":"string","description":"The timestamp of when the payment 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","uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"failureReason":{"required":["failureReason"],"type":"object","properties":{"failureCode":{"type":"string","description":"Reason for the failure:\n* `NO_AUTHENTICATION` - The API token was not found in the request headers.\n* `AUTHENTICATION_ERROR` - The API token in the request headers is not valid.\n* `AUTHORISATION_ERROR` - The API Token in the request header is not authorised to make this request.\n* `HTTP_SIGNATURE_ERROR` - The signature you have passed with the request did not pass verification.\n* `INVALID_INPUT` - We were unable to parse the payload of the request.\n* `MISSING_PARAMETER` - A mandatory parameter was missing from the request body.\n* `UNSUPPORTED_PARAMETER` - An unsupported parameter was found in the request body.\n* `INVALID_PARAMETER` - A parameter had an incorrect value.\n* `DUPLICATE_METADATA_FIELD` - A duplicate field was found in payment metadata.\n* `PAYOUTS_NOT_ALLOWED` - Payouts are not enabled with the provider on your PawaPay account.\n* `INVALID_PHONE_NUMBER` - The phone number provided is in the wrong format.\n* `INVALID_AMOUNT` - The amount contains decimals which is not supported by the provider.\n* `PAWAPAY_WALLET_OUT_OF_FUNDS` - Your PawaPay wallet does not have the funds to complete this refund.\n* `INVALID_CURRENCY` - The currency is not supported by the provider.\n* `INVALID_PROVIDER` - The provider is not valid for this request. \n* `PROVIDER_TEMPORARILY_UNAVAILABLE` - The provider is not currently not able to accept payments. \n* `UNKNOWN_ERROR` - The provider is not valid for this request.\n","enum":["NO_AUTHENTICATION","AUTHENTICATION_ERROR","AUTHORISATION_ERROR","HTTP_SIGNATURE_ERROR","INVALID_INPUT","MISSING_PARAMETER","UNSUPPORTED_PARAMETER","INVALID_PARAMETER","DUPLICATE_METADATA_FIELD","PAYOUTS_NOT_ALLOWED","INVALID_PHONE_NUMBER","INVALID_AMOUNT","PAWAPAY_WALLET_OUT_OF_FUNDS","INVALID_CURRENCY","INVALID_PROVIDER","PROVIDER_TEMPORARILY_UNAVAILABLE","UNKNOWN_ERROR"],"uniqueKey":"failureReason.failureCode","typeLabel":"enum\u003cstring>"},"failureMessage":{"type":"string","description":"A description of the failure","uniqueKey":"failureReason.failureMessage","typeLabel":"string"}},"uniqueKey":"failureReason","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ACCEPTED":{"title":"ACCEPTED","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"ACCEPTED","created":"2020-10-19T11:17:01Z"}},"DUPLICATE_IGNORED":{"title":"DUPLICATE_IGNORED","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"DUPLICATE_IGNORED","created":"2020-10-19T11:17:01Z"}},"PROVIDER_TEMPORARILY_UNAVAILABLE":{"title":"PROVIDER_TEMPORARILY_UNAVAILABLE","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"PROVIDER_TEMPORARILY_UNAVAILABLE","failureMessage":"The provider 'MTN_MOMO_ZMB' is currently not able to process payments. Please consult our status page for downtime information on all providers. Programmatic access is also available, please consult our API docs."}}},"INVALID_PHONE_NUMBER":{"title":"INVALID_PHONE_NUMBER","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"INVALID_PHONE_NUMBER","failureMessage":"The phone number '2607634' seems to be invalid for the provider 'MTN_MOMO_ZMB'."}}},"INVALID_CURRENCY":{"title":"INVALID_CURRENCY","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"INVALID_CURRENCY","failureMessage":"The currency 'USD' is not supported with provider 'MTN_MOMO_ZMB'. Please consult API docs for supported currencies."}}},"INVALID_AMOUNT":{"title":"INVALID_AMOUNT","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"INVALID_AMOUNT","failureMessage":"The provider MTN_MOMO_ZMB only supports up to '2' decimal places in amount."}}},"AMOUNT_OUT_OF_BOUNDS":{"title":"AMOUNT_OUT_OF_BOUNDS","value":{"payoutId":null,"status":"REJECTED","failureReason":{"failureCode":"AMOUNT_OUT_OF_BOUNDS","failureMessage":"The amount needs to be more than '1' and less than '20000' for provider 'MTN_MOMO_ZMB'."}}}},"exampleType":"examples"}},"exampleType":"examples"},"36c669b1-2105-47c8-a510-99ba940e2a5d":{"description":"Request was rejected due to incompatibility with PawaPay API specification","content":{"application/json":{"schema":{"type":"object","required":["failureCode","failureMessage"],"properties":{"payoutId":{"minLength":36,"maxLength":36,"type":"string","format":"uuid","description":"The unique ID for this payment in PawaPay as specified by you during initiation.","example":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","uniqueKey":"payoutId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["REJECTED"],"description":"The status of the response will always be `REJECTED`","example":"REJECTED","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"failureReason":{"required":["failureReason"],"type":"object","properties":{"failureCode":{"type":"string","description":"Reason for the failure:\n* `NO_AUTHENTICATION` - The API token was not found in the request headers.\n* `AUTHENTICATION_ERROR` - The API token in the request headers is not valid.\n* `AUTHORISATION_ERROR` - The API Token in the request header is not authorised to make this request.\n* `HTTP_SIGNATURE_ERROR` - The signature you have passed with the request did not pass verification.\n* `INVALID_INPUT` - We were unable to parse the payload of the request.\n* `MISSING_PARAMETER` - A mandatory parameter was missing from the request body.\n* `UNSUPPORTED_PARAMETER` - An unsupported parameter was found in the request body.\n* `INVALID_PARAMETER` - A parameter had an incorrect value.\n* `DUPLICATE_METADATA_FIELD` - A duplicate field was found in payment metadata.\n* `PAYOUTS_NOT_ALLOWED` - Payouts are not enabled with the provider on your PawaPay account.\n* `INVALID_PHONE_NUMBER` - The phone number provided is in the wrong format.\n* `INVALID_AMOUNT` - The amount contains decimals which is not supported by the provider.\n* `PAWAPAY_WALLET_OUT_OF_FUNDS` - Your PawaPay wallet does not have the funds to complete this refund.\n* `INVALID_CURRENCY` - The currency is not supported by the provider.\n* `INVALID_PROVIDER` - The provider is not valid for this request. \n* `PROVIDER_TEMPORARILY_UNAVAILABLE` - The provider is not currently not able to accept payments. \n* `UNKNOWN_ERROR` - The provider is not valid for this request.\n","enum":["NO_AUTHENTICATION","AUTHENTICATION_ERROR","AUTHORISATION_ERROR","HTTP_SIGNATURE_ERROR","INVALID_INPUT","MISSING_PARAMETER","UNSUPPORTED_PARAMETER","INVALID_PARAMETER","DUPLICATE_METADATA_FIELD","PAYOUTS_NOT_ALLOWED","INVALID_PHONE_NUMBER","INVALID_AMOUNT","PAWAPAY_WALLET_OUT_OF_FUNDS","INVALID_CURRENCY","INVALID_PROVIDER","PROVIDER_TEMPORARILY_UNAVAILABLE","UNKNOWN_ERROR"],"uniqueKey":"failureReason.failureCode","typeLabel":"enum\u003cstring>"},"failureMessage":{"type":"string","description":"A description of the failure","uniqueKey":"failureReason.failureMessage","typeLabel":"string"}},"uniqueKey":"failureReason","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"INVALID_INPUT":{"title":"INVALID_INPUT","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"INVALID_INPUT","failureMessage":"We are unable to parse the body of the request. Please consult API documentation for valid request payload."}}},"MISSING_PARAMETER":{"title":"MISSING_PARAMETER","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"MISSING_PARAMETER","failureMessage":"Request does not include the required parameter 'amount'."}}},"INVALID_PARAMETER":{"title":"INVALID_PARAMETER","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"INVALID_PARAMETER","failureMessage":"Value for parameter 'provider' is invalid. Please consult API documentation for validation rules."}}},"UNSUPPORTED_PARAMETER":{"title":"UNSUPPORTED_PARAMETER","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"UNSUPPORTED_PARAMETER","failureMessage":"Request includes an unsupported parameter 'amnt'. Please remove unsupported parameters from request body."}}}},"exampleType":"examples"}},"exampleType":"examples"},"00ba1066-adfc-4f71-aeb7-fc75c64092a7":{"description":"Authentication failed. Make sure you have added the API token into the header. If using signatures, make sure they are valid.","content":{"application/json":{"schema":{"type":"object","required":["failureCode","failureMessage"],"properties":{"payoutId":{"minLength":36,"maxLength":36,"type":"string","format":"uuid","description":"The unique ID for this payment in PawaPay as specified by you during initiation.","example":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","uniqueKey":"payoutId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["REJECTED"],"description":"The status of the response will always be `REJECTED`","example":"REJECTED","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"failureReason":{"required":["failureReason"],"type":"object","properties":{"failureCode":{"type":"string","description":"Reason for the failure:\n* `NO_AUTHENTICATION` - The API token was not found in the request headers.\n* `AUTHENTICATION_ERROR` - The API token in the request headers is not valid.\n* `HTTP_SIGNATURE_ERROR` - The signature you have passed with the request did not pass verification.\n","enum":["NO_AUTHENTICATION","AUTHENTICATION_ERROR","HTTP_SIGNATURE_ERROR"],"uniqueKey":"failureReason.failureCode","typeLabel":"enum\u003cstring>"},"failureMessage":{"type":"string","description":"A description of the failure","uniqueKey":"failureReason.failureMessage","typeLabel":"string"}},"uniqueKey":"failureReason","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"AUTHENTICATION_ERROR":{"title":"AUTHENTICATION_ERROR","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"AUTHENTICATION_ERROR","failureMessage":"The API token in the request is invalid."}}}},"exampleType":"examples"}},"exampleType":"examples"},"81973dbb-949c-442d-920b-fd2c0d6d21f3":{"description":"Authorization failure. Please check your authentication token.","content":{"application/json":{"schema":{"type":"object","required":["failureCode","failureMessage"],"properties":{"payoutId":{"minLength":36,"maxLength":36,"type":"string","format":"uuid","description":"The unique ID for this payment in PawaPay as specified by you during initiation.","example":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","uniqueKey":"payoutId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["REJECTED"],"description":"The status of the response will always be `REJECTED`","example":"REJECTED","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"failureReason":{"required":["failureReason"],"type":"object","properties":{"failureCode":{"type":"string","description":"Reason for the failure:\n* `AUTHORISATION_ERROR` - The API Token in the request header is not authorised to make this request.\n* `DEPOSITS_NOT_ALLOWED` - Deposits are not enabled with the provider on your PawaPay account.\n* `PAYOUTS_NOT_ALLOWED` - Payouts are not enabled with the provider on your PawaPay account.\n* `REMITTANCES_NOT_ALLOWED` - Remittances are not enabled with the provider on your PawaPay account.\n* `REFUNDS_NOT_ALLOWED` - Refunds are not enabled with the provider on your PawaPay account.\n","enum":["AUTHORISATION_ERROR","DEPOSITS_NOT_ALLOWED","PAYOUTS_NOT_ALLOWED","REMITTANCES_NOT_ALLOWED","REFUNDS_NOT_ALLOWED"],"uniqueKey":"failureReason.failureCode","typeLabel":"enum\u003cstring>"},"failureMessage":{"type":"string","description":"A description of the failure","uniqueKey":"failureReason.failureMessage","typeLabel":"string"}},"uniqueKey":"failureReason","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"AUTHORISATION_ERROR":{"title":"AUTHORISATION_ERROR","value":{"payoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","status":"REJECTED","failureReason":{"failureCode":"AUTHORISATION_ERROR","failureMessage":"The API token in the request is not authorised for this endpoint."}}}},"exampleType":"examples"}},"exampleType":"examples"},"0d34cc32-3d96-4de0-aae6-65a19e488e20":{"description":"An unknown failure has occurred.","content":{"application/json":{"schema":{"type":"object","required":["failureCode","failureMessage"],"properties":{"failureReason":{"type":"object","properties":{"failureCode":{"type":"string","description":"Reason for the failure:\n* `UNKNOWN_ERROR` - Unable to process request due to an unknown problem.\n","example":"UNKNOWN_ERROR","uniqueKey":"failureReason.failureCode","typeLabel":"string"},"failureMessage":{"type":"string","description":"A description of the failure","example":"Unable to process request due to an unknown problem.","uniqueKey":"failureReason.failureMessage","typeLabel":"string"}},"uniqueKey":"failureReason","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"UNKNOWN_ERROR":{"title":"UNKNOWN_ERROR","value":{"failureReason":{"failureCode":"UNKNOWN_ERROR","failureMessage":"Unable to process request due to an unknown problem."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b5c32e51-470f-4ecf-869d-e12b6610cbf5":{"bearerAuth":{"type":"http","description":"See [Authentication](/v2/docs/how_to_start#how-to-authenticate-calls-to-the-merchant-api).","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"332d3246-544a-43e8-a048-d892bbfd6c56":{"url":"https://api.sandbox.pawapay.io","description":"PawaPay Merchant API sandbox"},"b2edd67b-6644-48f0-ad04-0671ca7dc003":{"url":"https://api.pawapay.io","description":"PawaPay Merchant API production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"See [Authentication](/v2/docs/how_to_start#how-to-authenticate-calls-to-the-merchant-api).","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"See [Authentication](/v2/docs/how_to_start#how-to-authenticate-calls-to-the-merchant-api).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"v2/api-reference/openapi_v2.yaml"},"subdomain":"pawapay","siteName":"PawaPay Merchant API","title":"Initiate payout - PawaPay Merchant API","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/api-reference/payouts/initiate-payout","matchLevel":0},"v1":{"href":"/v1/api-reference/payouts/request-payout","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T13:42:34.849Z","originalFileLocation":"v2/api-reference/payouts/initiate-payout.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=\"Initiate payout - 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/v2/api-reference/payouts/initiate-payout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pawapay.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Initiate+payout\u0026amp;theme=119b7819cefae4f702f94c70\u0026amp;signature=c0567a91cfd9f6b1e7b72733a01eb7edfffd562fde07e1926e9e5285bb6a1da9\">\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=\"Initiate payout - PawaPay Merchant API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pawapay.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Initiate+payout\u0026amp;theme=119b7819cefae4f702f94c70\u0026amp;signature=c0567a91cfd9f6b1e7b72733a01eb7edfffd562fde07e1926e9e5285bb6a1da9\">\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/v2/api-reference/payouts/initiate-payout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/payouts/initiate-payout.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/v2/api-reference/payouts/initiate-payout#webpage\",\"url\":\"https://docs.pawapay.io/v2/api-reference/payouts/initiate-payout\",\"name\":\"Initiate payout\",\"dateModified\":\"2026-10-28T13:42:34.849Z\",\"isPartOf\":{\"@id\":\"https://docs.pawapay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pawapay.io/v2/api-reference/payouts/initiate-payout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pawapay.io/v2/api-reference/payouts/initiate-payout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"PawaPay Merchant API\",\"item\":\"https://docs.pawapay.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Initiate payout\",\"item\":\"https://docs.pawapay.io/v2/api-reference/payouts/initiate-payout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pawapay.io/v2/api-reference/payouts/initiate-payout#apireference\",\"headline\":\"Initiate payout\",\"name\":\"Initiate payout\",\"url\":\"https://docs.pawapay.io/v2/api-reference/payouts/initiate-payout\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pawapay.io/v2/api-reference/payouts/initiate-payout#webpage\"},\"dateModified\":\"2026-10-28T13:42:34.849Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","tabs":[{"tab":"API docs","pages":[{"title":"API docs","href":"/v2/docs/welcome"}]},{"tab":"API Reference","groups":[{"group":"Deposits","pages":[{"openapi":"v2/api-reference/openapi_v2.yaml POST /v2/deposits","title":"Initiate deposit","href":"/v2/api-reference/deposits/initiate-deposit"},{"openapi":"openapi_v2 get /v2/deposits/{depositId}","title":"Check deposit status","href":"/v2/api-reference/deposits/check-deposit-status"},{"openapi":"openapi_v2 post /v2/deposits/resend-callback/{depositId}","title":"Resend deposit callback","href":"/v2/api-reference/deposits/resend-deposit-callback"},{"title":"Deposit callback","icon":"webhook","description":null,"href":"/v2/api-reference/deposits/deposit-callback"}]},{"group":"Payouts","pages":[{"openapi":"openapi_v2 post /v2/payouts","title":"Initiate payout","href":"/v2/api-reference/payouts/initiate-payout"},{"openapi":"openapi_v2 get /v2/payouts/{payoutId}","title":"Check payout status","description":null,"href":"/v2/api-reference/payouts/check-payout-status"},{"openapi":"openapi_v2 post /v2/payouts/resend-callback/{payoutId}","title":"Resend payout callback","href":"/v2/api-reference/payouts/resend-payout-callback"},{"openapi":"openapi_v2 post /v2/payouts/fail-enqueued/{payoutId}","title":"Cancel enqueued payout","href":"/v2/api-reference/payouts/cancel-enqueued-payout"},{"openapi":"v2/api-reference/openapi_v2.yaml POST /v2/payouts/bulk","title":"Initiate bulk payouts","href":"/v2/api-reference/payouts/initiate-bulk-payout"},{"title":"Payout callback","icon":"webhook","href":"/v2/api-reference/payouts/payout-callback"}]},{"group":"Refunds","pages":[{"openapi":"openapi_v2 post /v2/refunds","title":"Initiate refund","href":"/v2/api-reference/refunds/initiate-refund"},{"openapi":"openapi_v2 get /v2/refunds/{refundId}","title":"Check refund status","href":"/v2/api-reference/refunds/check-refund-status"},{"openapi":"openapi_v2 post /v2/refunds/resend-callback/{refundId}","title":"Resend refund callback","href":"/v2/api-reference/refunds/resend-refund-callback"},{"openapi":"openapi_v2 post /v2/refunds/fail-enqueued/{refundId}","title":"Cancel enqueued refund","href":"/v2/api-reference/refunds/cancel-enqueued-refund"},{"title":"Refund callback","icon":"webhook","href":"/v2/api-reference/refunds/refund-callback"}]},{"group":"Remittances","pages":[{"openapi":"openapi_v2 post /v2/remittances","title":"Initiate remittance","href":"/v2/api-reference/remittances/initiate-remittance"},{"openapi":"openapi_v2 get /v2/remittances/{remittanceId}","title":"Check remittance status","href":"/v2/api-reference/remittances/check-remittance-status"},{"openapi":"openapi_v2 post /v2/remittances/resend-callback/{remittanceId}","title":"Resend remittance callback","href":"/v2/api-reference/remittances/resend-remittance-callback"},{"openapi":"openapi_v2 post /v2/remittances/fail-enqueued/{remittanceId}","title":"Cancel enqueued remittance","href":"/v2/api-reference/remittances/cancel-enqueued-remittance"},{"title":"Remittance callback","icon":"webhook","href":"/v2/api-reference/remittances/remittance-callback"}]},{"group":"Checkouts","pages":[{"openapi":"openapi_v2 post /v2/checkouts","title":"Initiate checkout","href":"/v2/api-reference/checkouts/initiate-checkout"},{"openapi":"openapi_v2 get /v2/checkouts/{checkoutId}","title":"Check checkout status","href":"/v2/api-reference/checkouts/check-checkout-status"},{"openapi":"openapi_v2 post /v2/checkouts/{checkoutId}/expire","title":"Expire checkout","href":"/v2/api-reference/checkouts/expire-checkout"},{"title":"Checkout callback","icon":"webhook","href":"/v2/api-reference/checkouts/checkout-callback"}]},{"group":"Payment page","pages":[{"openapi":"openapi_v2 post /v2/paymentpage","title":"Deposit via Payment Page","href":"/v2/api-reference/payment-page/deposit-via-payment-page"}]},{"group":"Finances","pages":[{"openapi":"openapi_v2 get /v2/wallet-balances","title":"Wallet balances","href":"/v2/api-reference/finances/wallet-balances"},{"openapi":"openapi_v2 get /v2/wallet-breakdowns","title":"Wallet breakdowns","href":"/v2/api-reference/finances/wallet-breakdowns"},{"openapi":"openapi_v2 post /v2/statements","title":"Statements","href":"/v2/api-reference/finances/initiate-statement"},{"openapi":"openapi_v2 get /v2/statements/{statementId}","title":"Check statement status","href":"/v2/api-reference/finances/check-statement-status"},{"title":"Statement callback","icon":"webhook","href":"/v2/api-reference/finances/statement-callback"},{"openapi":"openapi_v2 get /v2/settlements","title":"Settlements","href":"/v2/api-reference/finances/settlements"}]},{"group":"Toolkit","pages":[{"openapi":"openapi_v2 get /v2/active-conf","title":"Active Configuration","href":"/v2/api-reference/toolkit/active-configuration"},{"openapi":"openapi_v2 get /v2/availability","title":"Provider Availability","href":"/v2/api-reference/toolkit/availability"},{"openapi":"openapi_v2 post /v2/predict-provider","title":"Predict Provider","href":"/v2/api-reference/toolkit/predict-provider"},{"openapi":"openapi_v2 get /v2/public-key/http","title":"Public Keys","href":"/v2/api-reference/toolkit/public-keys"}]}]},{"tab":"Dashboard Docs","pages":[{"title":"Dashboard Docs","href":"/dashboard/introduction"}]}]},{"version":"v1","pages":[{"title":"v1","href":"/v1/api-reference/payouts/request-payout"}]}]},"basePath":"","title":"Initiate payout - PawaPay Merchant API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}