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.
If specified, this phone number will be used to collect the deposit. If not specified, the customer paying can specify the phone number that they want to pay from.
The language in which the Payment Page will be presented to the customer. If the user has explicitly changed their languages preferences, their selection will override this parameter.
If specifified, allows payment from phone numbers only from a specific country.
If not specified, the customer can select any country that is configured for your account in PawaPay.
You can use the active configuration endpoint to verify which counrties and MMOs have been configured for your account.
Format must be the ISO 3166-1 alpha-3, three character country code in upper case. Read more from Wikipedia.
A list of metadata that you can attach to the payment for providing additional context about the payment.
For example, adding orderId to indicate for which order this payment was for or customerId to know which customer this payment pertains to.
Metadata will not be visible to the customer that is party to this payment.
It will be visible in the PawaPay Dashboard on the payment details page and in your financial statements as a JSON object to support automated reconciliation.
It is also possible to search for recent payments in the PawaPay Dashboard using global search based on the values of metadata.
Up to 10 metadata fields can be attached to a payment.
The unique URL of the payment page for this specific payment session. Customer has to be forwarded to this URL where they can complete the payment.
The session is valid for 15 minutes for the customer to complete the payment.
{"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":"6aeb3bff245c712a705a8821","clientVersion":"0.0.4088","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":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"v1/api-reference/payment-page/deposit-via-payment-page","slug":"/v1/api-reference/payment-page/deposit-via-payment-page","pageMetadata":{"openapi":"openapi_v1 post /v1/widget/sessions","description":null,"title":"Deposit via Payment Page","href":"/v1/api-reference/payment-page/deposit-via-payment-page"},"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`,li:`li`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,Table}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Initiates a payment session using the PawaPay Payment Page.`}),`\n`,_jsx(Card,{title:`Learn more!`,icon:`readme`,href:`/payment_page`,horizontal:`true`,children:_jsx(_components.p,{children:`See how the Payment Page works for your customers.`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The request will return a `,_jsx(_components.code,{children:`redirectURL`}),`.`]}),`\n`,_jsx(_components.li,{children:`The customer should be forwarded to this URL to start the payment process.`}),`\n`,_jsxs(_components.li,{children:[`Once the customer completes the payment process on the Payment Page, they will be forwarded to the `,_jsx(_components.code,{children:`returnUrl`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`The original `,_jsx(_components.code,{children:`depositId`}),` will be passed as a query parameter.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Your page on the `,_jsx(_components.code,{children:`returnUrl`}),` has two options to determine the status of the payment. You can do that by either:`]}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Waiting for a callback`,icon:`webhook`,href:`/v1/api-reference/deposits/deposit-callback`,horizontal:`true`,children:_jsx(_components.p,{children:`If you have configured callbacks, just wait for it.`})}),_jsx(Card,{title:`Checking the status`,icon:`code-compare`,href:`/v1/api-reference/deposits/check-deposit-status`,horizontal:`true`,children:_jsx(_components.p,{children:`Or poll the Check Deposit Status endpoint.`})})]}),`\n`,_jsx(_components.p,{children:`The customer experience of the Payment Page can be changed through the following parameters during initiation.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Behaviour if specified`}),_jsx(_components.th,{children:`Behaviour if not specified`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`amount`})}),_jsx(_components.td,{children:`The specified amount will be used for the payment. Customer is not able to change it.`}),_jsx(_components.td,{children:`The customer is able to enter the amount they wish to pay. For example, when depositing into their eWallet.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`msisdn`})}),_jsx(_components.td,{children:`The payment will be initiated from the specified mobile money wallet. Customer is not able to change it.`}),_jsx(_components.td,{children:`The customer can specify the phone number of the mobile money wallet they wish to pay from.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`country`})}),_jsx(_components.td,{children:`The customer can pay only using a mobile money wallet from the specified country.`}),_jsx(_components.td,{children:`The customer can pay with a mobile money wallet from any country that is configured on your PawaPay account.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`reason`})}),_jsx(_components.td,{children:`The reason will be shown to the customer on the Payment Page`}),_jsx(_components.td,{children:`The customer will not be shown what they are paying for.`})]})]})]})]})}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_v1 post /v1/widget/sessions","description":null,"title":"Deposit via Payment Page","href":"/v1/api-reference/payment-page/deposit-via-payment-page"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["payment-page"],"summary":"Deposit via Payment Page","operationId":"create-session","requestBody":"6e1ebadd-ca60-439c-bc1b-0c0d705f2b95","responses":{"200":"40034672-9965-4097-9378-4efbb193b239","400":"d6eb487f-6e9f-43d5-bc4b-5b3cb01f9516","401":"0bfcb04e-e9bf-4ece-a525-11c19559b552","403":"bb5ee58e-b8fc-49c0-a1fe-7570fb1e1e54","500":"d5ef5ca2-78a3-46a0-9fe3-22761fc0334b"},"method":"post","type":"path","servers":["321c7a20-9195-42cf-bd7e-d3f33a9abfd1","0a99643b-f413-409a-af4c-2db4372b65d3"],"security":["38397491-e1d3-47bd-a29e-385725b84bce"],"path":"/v1/widget/sessions","baseUrlOptions":["https://api.sandbox.pawapay.io","https://api.pawapay.io"],"title":"Deposit via Payment Page","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["depositId","returnUrl"],"properties":{"depositId":{"minLength":36,"maxLength":36,"type":"string","format":"uuid","description":"A UUIDv4 based ID specified by you, that uniquely identifies the deposit.","example":"\u003cINSERT_UUID_FOR_DEPOSIT>","isRequired":true,"uniqueKey":"depositId","typeLabel":"string\u003cuuid>"},"returnUrl":{"type":"string","format":"uri","example":"https://merchant.com/paymentProcessed","description":"The URL to which the user will be redirected after completion of the operation.","isRequired":true,"uniqueKey":"returnUrl","typeLabel":"string\u003curi>"},"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":"statementDescription","typeLabel":"string"},"amount":{"minLength":1,"maxLength":23,"type":"string","pattern":"^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$","description":"If specified, the amount will be displayed to the customer as the payment amount. For example, when paying for specific goods or services.\n\nIf not specified, the customer will have to specify the amount they wish to pay. For example, when depositing money into their eWallet.\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 amounts depend 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","uniqueKey":"amount","typeLabel":"string"},"msisdn":{"type":"string","description":"If specified, this phone number will be used to collect the deposit. If not specified, the customer paying can specify the phone number that they want to pay from.\n\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","uniqueKey":"msisdn","typeLabel":"string"},"language":{"type":"string","description":"The language in which the Payment Page will be presented to the customer. If the user has explicitly changed their languages preferences, their selection will override this parameter.\n","example":"EN","enum":["EN","FR"],"uniqueKey":"language","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"If specifified, allows payment from phone numbers only from a specific country. \nIf not specified, the customer can select any country that is configured for your account in PawaPay. \n\nYou can use the [active configuration](#operation/active-conf) endpoint to verify which counrties and MMOs have been configured for your account. \n\nFormat must be the 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","uniqueKey":"country","typeLabel":"string"},"reason":{"type":"string","minLength":1,"maxLength":50,"description":"Optional text which will be displayed to the customer on the payment page to specify what they are paying for.","example":"Ticket to festival","uniqueKey":"reason","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 `orderId` to indicate for which order this payment was for or `customerId` to know which customer this payment pertains to.\n\nMetadata will not be visible to the customer that is party to this payment. \nIt will be visible in the PawaPay Dashboard on the payment details page and in your financial statements as a JSON object to support automated reconciliation.\nIt is also possible to search for recent payments in the PawaPay Dashboard using global search based on the values of metadata.\n\nUp to 10 metadata fields can be attached to a payment. \n","type":"array","items":{"required":["fieldName","fieldValue"],"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the metadata that you are attaching to the payment. For example `orderId`.","example":"orderId","isRequired":true,"uniqueKey":"metadata.items.[INDEX].fieldName","typeLabel":"string"},"fieldValue":{"type":"string","description":"The value for this metadata field. For example `ORD-123456789`.","example":"ORD-123456789","isRequired":true,"uniqueKey":"metadata.items.[INDEX].fieldValue","typeLabel":"string"},"isPII":{"type":"boolean","default":false,"description":"Indicates whether the field contains personally identifiable information. Used for enabling compliance with GDPR or other relevant data privacy laws.","example":true,"uniqueKey":"metadata.items.[INDEX].isPII","typeLabel":"boolean"}},"uniqueKey":"metadata.items.[INDEX]","typeLabel":"object"},"example":[{"fieldName":"orderId","fieldValue":"ORD-123456789"},{"fieldName":"customerId","fieldValue":"customer@email.com","isPII":true}],"uniqueKey":"metadata","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"depositId":"\u003cINSERT_UUID_FOR_DEPOSIT>","returnUrl":"https://merchant.com/paymentProcessed","statementDescription":"Note of 4 to 22 chars","amount":"15","msisdn":"260763456789","language":"EN","country":"ZMB","reason":"Ticket to festival","metadata":[{"fieldName":"orderId","fieldValue":"ORD-123456789"},{"fieldName":"customerId","fieldValue":"customer@email.com","isPII":true}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"40034672-9965-4097-9378-4efbb193b239":{"description":"Payment Page session is created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"redirectUrl":{"type":"string","format":"uri","description":"The unique URL of the payment page for this specific payment session. Customer has to be forwarded to this URL where they can complete the payment. \nThe session is valid for 15 minutes for the customer to complete the payment.\n\n**Please note! The URL is valid for 5 minutes.**\n","example":"https://paywith.pawapay.io/?token=AgV4aA3ZxKfGcdMIo6a6Upf7X2MRptdFUrc6Oi3U53CxC0YAkAADABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREFzdDR5WktOeWVTRTZ5bTdhVTJJeno3bG1ydkFYenFpUWZqNVQxbGQ2RUgweEpkZVZ0cWJGM3hwMzI1VWN6VGxEdz09AAdwdXJwb3NlAA5jcmVhdGUtc2Vzc2lvbgAFc3RhZ2UAD3NpZ24tY2xvdWRmcm9udAACAAdhd3Mta21zAE5hcm46YXdzOmttczpldS1jZW50cmFsLTE6MTAxOTQ0Mzc3ODY2OmtleS82ZTgzZmVjMS00MWRhLTQxMWQt","uniqueKey":"redirectUrl","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"redirectUrl":"https://paywith.pawapay.io/?token=AgV4aA3ZxKfGcdMIo6a6Upf7X2MRptdFUrc6Oi3U53CxC0YAkAADABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREFzdDR5WktOeWVTRTZ5bTdhVTJJeno3bG1ydkFYenFpUWZqNVQxbGQ2RUgweEpkZVZ0cWJGM3hwMzI1VWN6VGxEdz09AAdwdXJwb3NlAA5jcmVhdGUtc2Vzc2lvbgAFc3RhZ2UAD3NpZ24tY2xvdWRmcm9udAACAAdhd3Mta21zAE5hcm46YXdzOmttczpldS1jZW50cmFsLTE6MTAxOTQ0Mzc3ODY2OmtleS82ZTgzZmVjMS00MWRhLTQxMWQt"}}},"exampleType":"generated"}},"exampleType":"generated"},"d6eb487f-6e9f-43d5-bc4b-5b3cb01f9516":{"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":{"INVALID_INPUT":{"title":"INVALID_INPUT","value":{"errorId":"94bd5e86-9bc4-4328-b128-c705f6496db8","errorCode":1,"errorMessage":"INVALID_INPUT: Missing required property 'returnUrl'"}}},"exampleType":"examples"}},"exampleType":"examples"},"0bfcb04e-e9bf-4ece-a525-11c19559b552":{"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":{"Unauthorized":{"title":"Unauthorized","value":{"message":"Unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"bb5ee58e-b8fc-49c0-a1fe-7570fb1e1e54":{"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":{"Forbidden":{"title":"Forbidden","value":{"message":"Missing Authentication Token"}}},"exampleType":"examples"}},"exampleType":"examples"},"d5ef5ca2-78a3-46a0-9fe3-22761fc0334b":{"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":{"Internal Server Error":{"title":"Internal Server Error","value":{"errorId":"94bd5e86-9bc4-4328-b128-c705f6496db8","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":"Deposit via Payment Page - PawaPay Merchant API","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/api-reference/payment-page/deposit-via-payment-page","matchLevel":1},"v1":{"href":"/v1/api-reference/payment-page/deposit-via-payment-page","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T13:42:35.085Z","originalFileLocation":"v1/api-reference/payment-page/deposit-via-payment-page.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=\"Deposit via Payment Page - 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/payment-page/deposit-via-payment-page\">\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=Payment+page\u0026amp;title=Deposit+via+Payment+Page\u0026amp;theme=119b7819cefae4f702f94c70\u0026amp;signature=d6887a68927deb0e14ab65c4429a427f3ee68af4e21c529009e72753b5322218\">\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=\"Deposit via Payment Page - PawaPay Merchant API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pawapay.mintlify.site/_mintlify/api/og/v2?division=Payment+page\u0026amp;title=Deposit+via+Payment+Page\u0026amp;theme=119b7819cefae4f702f94c70\u0026amp;signature=d6887a68927deb0e14ab65c4429a427f3ee68af4e21c529009e72753b5322218\">\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/payment-page/deposit-via-payment-page\">\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/payment-page/deposit-via-payment-page.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/payment-page/deposit-via-payment-page#webpage\",\"url\":\"https://docs.pawapay.io/v1/api-reference/payment-page/deposit-via-payment-page\",\"name\":\"Deposit via Payment Page\",\"dateModified\":\"2026-10-28T13:42:35.085Z\",\"isPartOf\":{\"@id\":\"https://docs.pawapay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pawapay.io/v1/api-reference/payment-page/deposit-via-payment-page#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pawapay.io/v1/api-reference/payment-page/deposit-via-payment-page#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"PawaPay Merchant API\",\"item\":\"https://docs.pawapay.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Deposit via Payment Page\",\"item\":\"https://docs.pawapay.io/v1/api-reference/payment-page/deposit-via-payment-page\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pawapay.io/v1/api-reference/payment-page/deposit-via-payment-page#apireference\",\"headline\":\"Deposit via Payment Page\",\"name\":\"Deposit via Payment Page\",\"url\":\"https://docs.pawapay.io/v1/api-reference/payment-page/deposit-via-payment-page\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pawapay.io/v1/api-reference/payment-page/deposit-via-payment-page#webpage\"},\"dateModified\":\"2026-10-28T13:42:35.085Z\",\"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","pages":[{"title":"v2","href":"/v2/api-reference/payment-page/deposit-via-payment-page"}]},{"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","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","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","description":null,"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","description":null,"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":"Deposit via Payment Page - PawaPay Merchant API","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}