API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.
If you have configured callbacks, PawaPay will POST a callback to your configured callback URL when a checkout reaches a final status (COMPLETED, FAILED, EXPIRED or CANCELLED).
Read more about callbacks.The callback payload is the checkout in its final state, including the latest payment attempt (deposit) and the full history of attempts (depositsHistory).If you have not configured callbacks, you can always call the Check checkout status endpoint to get the latest state of a specific checkout.
A checkout can contain multiple payment attempts, but at most one can complete successfully — PawaPay manages the retries for you.
If you prefer, each attempt also behaves like a standard deposit, so you can rely on the deposit callback for it.
Headers
Following headers are only included if you have enabled signed callbacks.Read more about how to implement signed callbacks.
A unique code identifying the checkout. It forms the path of the hosted payment page's redirectUrl and is appended to your returnUrl as the checkoutCode query parameter when the customer is returned to your site. Store it after initiating the checkout, so you can identify which checkout the customer is returning from.
Example:
"7mVk1x8UbTamQ64xGR"
returnUrl
string<uri>
The URL the customer should be redirected to after the payment is processed.
Example:
"https://merchant.example.com/checkout-result"
countries
string[]
The list of countries that the hosted payment page allowed for this checkout.
A country that the hosted payment page allows for this checkout.
Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from Wikipedia.
Required string length: 3
Example:
["ZMB", "CIV"]
amounts
object[]
The fixed amount the customer is asked to pay, specified per country and currency, as configured for this checkout.
When set, it contains an entry for each country in the countries array, defining the amount the customer pays for the country and currency they select on the hosted payment page. If not set, the customer enters the amount themselves on the hosted payment page.
Show child attributes
clientReferenceId
string
A reference to an entity in your system that this payment relates to. For example, an invoice ID, customer ID etc.
Example:
"INV-123456"
providerTransactionId
string
The unique ID for this payment assigned by the provider. The customer would see this ID on their SMS receipt and transaction history.
Example:
"ABC123"
depositStatus
enum<string>
Current aggregate status for the checkout, representing the latest payment attempt:
PROCESSING - The latest payment attempt is still being processed. Attempts undergoing reconciliation also remain PROCESSING until a final status is determined.
COMPLETED - The latest payment attempt completed successfully.
FAILED - The latest payment attempt failed.
Available options:
PROCESSING,
COMPLETED,
FAILED
deposit
object
Show child attributes
reason
object
Localized reason values shown to the customer inside the hosted payment page.
Show child attributes
Example:
{ "en": "GOODS PURCHASE" }
Was this page helpful?
{"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":"6afe97222238c3c29ae646ac","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API Reference","count":56},{"language":"default","tag":"API docs","count":27},{"language":"default","tag":"Dashboard Docs","count":26},{"language":"default","tag":"Payouts","count":12},{"language":"default","tag":"Introduction","count":11},{"language":"default","tag":"Finances","count":10},{"language":"default","tag":"Refunds","count":9},{"language":"default","tag":"Deposits","count":8},{"language":"default","tag":"Toolkit","count":8},{"language":"default","tag":"Overview","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"v2/api-reference/checkouts/checkout-callback","slug":"/v2/api-reference/checkouts/checkout-callback","pageMetadata":{"title":"Checkout callback","icon":"webhook","openapi-schema":"V2CheckoutCallback","description":"API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.","href":"/v2/api-reference/checkouts/checkout-callback"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Heading,Info,ParamField}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`If you have configured callbacks, PawaPay will `,_jsx(_components.code,{children:`POST`}),` a callback to your configured callback URL when a checkout reaches a final status (`,_jsx(_components.code,{children:`COMPLETED`}),`, `,_jsx(_components.code,{children:`FAILED`}),`, `,_jsx(_components.code,{children:`EXPIRED`}),` or `,_jsx(_components.code,{children:`CANCELLED`}),`).\nRead more about `,_jsx(_components.a,{href:`/v2/docs/what_to_know#callbacks`,children:`callbacks`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The callback payload is the checkout in its final state, including the latest payment attempt (`,_jsx(_components.code,{children:`deposit`}),`) and the full history of attempts (`,_jsx(_components.code,{children:`depositsHistory`}),`).`]}),`\n`,_jsxs(_components.p,{children:[`If you have not configured callbacks, you can always call the `,_jsx(_components.a,{href:`/v2/api-reference/checkouts/check-checkout-status`,children:`Check checkout status`}),` endpoint to get the latest state of a specific checkout.`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`A checkout can contain multiple payment attempts, but at most one can complete successfully — PawaPay manages the retries for you.\nIf you prefer, each attempt also behaves like a standard `,_jsx(_components.a,{href:`/v2/docs/deposits`,children:`deposit`}),`, so you can rely on the `,_jsx(_components.a,{href:`/v2/api-reference/deposits/deposit-callback`,children:`deposit callback`}),` for it.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`headers`,children:`Headers`}),`\n`,_jsxs(Info,{children:[_jsx(_components.p,{children:`Following headers are only included if you have enabled signed callbacks.`}),_jsxs(_components.p,{children:[`Read more about how to implement `,_jsx(_components.a,{href:`/v2/docs/signatures#signatures-in-callbacks`,children:`signed callbacks`}),`.`]})]}),`\n`,_jsx(ParamField,{header:`Content-Digest`,type:`string`,id:`param-content-digest`,children:_jsx(_components.p,{children:`SHA256 or SHA-512 hash of the request body.`})}),`\n`,_jsx(ParamField,{header:`Signature`,type:`String`,id:`param-signature`,children:_jsxs(_components.p,{children:[`Signature of the request according to `,_jsx(_components.a,{href:`https://datatracker.ietf.org/doc/rfc9421/`,children:`RFC-9421`}),`.`]})}),`\n`,_jsx(ParamField,{header:`Signature-Input`,type:`String`,id:`param-signature-input`,children:_jsxs(_components.p,{children:[`Signature input according to `,_jsx(_components.a,{href:`https://datatracker.ietf.org/doc/rfc9421/`,children:`RFC-9421`}),`.`]})}),`\n`,_jsx(ParamField,{header:`Signature-Date`,type:`String`,id:`param-signature-date`,children:_jsxs(_components.p,{children:[`Timestamp when the signature was created. This is a custom field and is not part of `,_jsx(_components.a,{href:`https://datatracker.ietf.org/doc/rfc9421/`,children:`RFC-9421`}),`.`]})}),`\n`,_jsx(ParamField,{header:`Accept-Signature`,type:`String`,id:`param-accept-signature`,children:_jsxs(_components.p,{children:[`Expected signature algorithm of the response according to `,_jsx(_components.a,{href:`https://datatracker.ietf.org/doc/rfc9421/`,children:`RFC-9421`}),`.`]})}),`\n`,_jsx(ParamField,{header:`Accept-Digest`,type:`String`,id:`param-accept-digest`,children:_jsxs(_components.p,{children:[`Expected digest algorithm of the response according to `,_jsx(_components.a,{href:`https://datatracker.ietf.org/doc/rfc9421/`,children:`RFC-9421`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`})]})}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":{"title":"Checkout callback","icon":"webhook","openapi-schema":"V2CheckoutCallback","description":"API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.","href":"/v2/api-reference/checkouts/checkout-callback"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Headers","slug":"headers","depth":3,"children":[]},{"title":"Body","slug":"body","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"description":"The callback delivered to your configured callback URL when a checkout reaches a final status (`COMPLETED`, `FAILED`, `EXPIRED` or `CANCELLED`).\n\nThe payload is the checkout in its final state, including the latest payment attempt and the full history of attempts.\n","required":["checkoutId","status","depositsHistory","metadata","created"],"type":"object","properties":{"checkoutId":{"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","isRequired":true,"uniqueKey":"checkoutId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Possible checkout lifecycle statuses. This is distinct from the initiation status (`CheckoutCreationStatus`) returned when the checkout is created.\n* `WAITING_PAYMENT` - The checkout and its hosted payment page have been created and are waiting for the customer to pay.\n* `PROCESSING` - A payment attempt is in progress and the checkout is still being processed.\n* `COMPLETED` - The checkout has completed successfully. This is a **final status.**\n* `FAILED` - The checkout has failed. Inspect `deposit` or `depositsHistory` for the latest attempt result when available. This is a **final status.**\n* `EXPIRED` - The checkout has expired and can no longer be used. This is a **final status.**\n* `CANCELLED` - The customer cancelled the payment on the hosted payment page. This is a **final status.**\n","enum":["WAITING_PAYMENT","PROCESSING","COMPLETED","FAILED","EXPIRED","CANCELLED"],"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","isRequired":true,"uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"depositsHistory":{"type":"array","description":"History of payment attempts within this checkout. A single checkout can contain multiple attempts, but at most one can complete successfully.","items":{"required":["depositId","status","created"],"type":"object","properties":{"depositId":{"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","isRequired":true,"uniqueKey":"depositsHistory.items.[INDEX].depositId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Possible statuses for a payment attempt inside the checkout:\n* `ACCEPTED` - The payment attempt has been accepted by PawaPay for processing.\n* `PROCESSING` - The payment attempt is being processed. Attempts undergoing reconciliation also remain `PROCESSING` until a final status is determined.\n* `COMPLETED` - The payment attempt completed successfully.\n* `FAILED` - The payment attempt failed.\n","enum":["ACCEPTED","PROCESSING","COMPLETED","FAILED"],"isRequired":true,"uniqueKey":"depositsHistory.items.[INDEX].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","isRequired":true,"uniqueKey":"depositsHistory.items.[INDEX].created","typeLabel":"string\u003cdate-time>"},"providerTransactionId":{"type":"string","description":"The unique ID for this payment assigned by the provider. The customer would see this ID on their SMS receipt and transaction history.","example":"ABC123","uniqueKey":"depositsHistory.items.[INDEX].providerTransactionId","typeLabel":"string"},"failureReason":{"description":"The failure reason of the payment attempt when its status is `FAILED`.","required":["failureCode"],"type":"object","properties":{"failureCode":{"type":"string","description":"Failure code of the payment attempt.\n\nCheckout payments use the same failure codes as standard deposits.\n","example":"PAYMENT_NOT_APPROVED","isRequired":true,"uniqueKey":"depositsHistory.items.[INDEX].failureReason.failureCode","typeLabel":"string"},"failureMessage":{"type":"string","description":"Human readable description of the payment attempt failure.","example":"The payer did not approve the payment.","uniqueKey":"depositsHistory.items.[INDEX].failureReason.failureMessage","typeLabel":"string"}},"uniqueKey":"depositsHistory.items.[INDEX].failureReason","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","uniqueKey":"depositsHistory.items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","description":"The currency in which the `amount` is specified.\n\nFormat must be the ISO 4217 three character currency code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\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","uniqueKey":"depositsHistory.items.[INDEX].currency","typeLabel":"string"},"country":{"type":"string","minLength":3,"maxLength":3,"description":"The country in which the payment was initiated.\n\nFormat is ISO 3166-1 alpha-3, three character country code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements).\n","example":"ZMB","uniqueKey":"depositsHistory.items.[INDEX].country","typeLabel":"string"},"payer":{"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":"depositsHistory.items.[INDEX].payer.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":"depositsHistory.items.[INDEX].payer.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":"depositsHistory.items.[INDEX].payer.accountDetails.provider","typeLabel":"string"}},"isRequired":true,"uniqueKey":"depositsHistory.items.[INDEX].payer.accountDetails","typeLabel":"object"}},"uniqueKey":"depositsHistory.items.[INDEX].payer","typeLabel":"object"},"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":"depositsHistory.items.[INDEX].customerMessage","typeLabel":"string"},"metadata":{"description":"The metadata that was provided in the original initation request in a JSON object format.\n","type":"object","properties":{"additionalProperties":{"type":"string","description":"Each passed in metadata field will be a property of the metadata JSON object.","uniqueKey":"depositsHistory.items.[INDEX].metadata.\\additionalProperties","typeLabel":"string"}},"example":{"orderId":"ORD-123456789","customerId":"customer@email.com"},"uniqueKey":"depositsHistory.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"depositsHistory.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"depositsHistory","typeLabel":"object[]"},"metadata":{"description":"The metadata that was provided in the original initation request in a JSON object format.\n","type":"object","properties":{"additionalProperties":{"type":"string","description":"Each passed in metadata field will be a property of the metadata JSON object.","uniqueKey":"metadata.\\additionalProperties","typeLabel":"string"}},"example":{"orderId":"ORD-123456789","customerId":"customer@email.com"},"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"},"checkoutCode":{"type":"string","description":"A unique code identifying the checkout. It forms the path of the hosted payment page's `redirectUrl` and is appended to your `returnUrl` as the `checkoutCode` query parameter when the customer is returned to your site. Store it after initiating the checkout, so you can identify which checkout the customer is returning from.","example":"7mVk1x8UbTamQ64xGR","uniqueKey":"checkoutCode","typeLabel":"string"},"returnUrl":{"type":"string","format":"uri","description":"The URL the customer should be redirected to after the payment is processed.","example":"https://merchant.example.com/checkout-result","uniqueKey":"returnUrl","typeLabel":"string\u003curi>"},"countries":{"type":"array","description":"The list of countries that the hosted payment page allowed for this checkout.","items":{"type":"string","minLength":3,"maxLength":3,"description":"A country that the hosted payment page allows for this checkout.\n\nFormat is ISO 3166-1 alpha-3, three character country code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements).\n","example":"ZMB","uniqueKey":"countries.items.[INDEX]","typeLabel":"string"},"example":["ZMB","CIV"],"uniqueKey":"countries","typeLabel":"string[]"},"amounts":{"type":"array","description":"The fixed amount the customer is asked to pay, specified per country and currency, as configured for this checkout.\n\nWhen set, it contains an entry for each country in the `countries` array, defining the amount the customer pays for the country and currency they select on the hosted payment page. If not set, the customer enters the amount themselves on the hosted payment page.\n","items":{"required":["country","currency","amount"],"type":"object","properties":{"country":{"type":"string","minLength":3,"maxLength":3,"description":"The country this amount is for.\n\nFormat is ISO 3166-1 alpha-3, three character country code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements).\n","example":"ZMB","isRequired":true,"uniqueKey":"amounts.items.[INDEX].country","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":"amounts.items.[INDEX].currency","typeLabel":"string"},"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":"amounts.items.[INDEX].amount","typeLabel":"string"}},"uniqueKey":"amounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"amounts","typeLabel":"object[]"},"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"},"providerTransactionId":{"type":"string","description":"The unique ID for this payment assigned by the provider. The customer would see this ID on their SMS receipt and transaction history.","example":"ABC123","uniqueKey":"providerTransactionId","typeLabel":"string"},"depositStatus":{"type":"string","description":"Current aggregate status for the checkout, representing the latest payment attempt:\n* `PROCESSING` - The latest payment attempt is still being processed. Attempts undergoing reconciliation also remain `PROCESSING` until a final status is determined.\n* `COMPLETED` - The latest payment attempt completed successfully.\n* `FAILED` - The latest payment attempt failed.\n","enum":["PROCESSING","COMPLETED","FAILED"],"uniqueKey":"depositStatus","typeLabel":"enum\u003cstring>"},"deposit":{"required":["depositId","status","created"],"type":"object","properties":{"depositId":{"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","isRequired":true,"uniqueKey":"deposit.depositId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Possible statuses for a payment attempt inside the checkout:\n* `ACCEPTED` - The payment attempt has been accepted by PawaPay for processing.\n* `PROCESSING` - The payment attempt is being processed. Attempts undergoing reconciliation also remain `PROCESSING` until a final status is determined.\n* `COMPLETED` - The payment attempt completed successfully.\n* `FAILED` - The payment attempt failed.\n","enum":["ACCEPTED","PROCESSING","COMPLETED","FAILED"],"isRequired":true,"uniqueKey":"deposit.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","isRequired":true,"uniqueKey":"deposit.created","typeLabel":"string\u003cdate-time>"},"providerTransactionId":{"type":"string","description":"The unique ID for this payment assigned by the provider. The customer would see this ID on their SMS receipt and transaction history.","example":"ABC123","uniqueKey":"deposit.providerTransactionId","typeLabel":"string"},"failureReason":{"description":"The failure reason of the payment attempt when its status is `FAILED`.","required":["failureCode"],"type":"object","properties":{"failureCode":{"type":"string","description":"Failure code of the payment attempt.\n\nCheckout payments use the same failure codes as standard deposits.\n","example":"PAYMENT_NOT_APPROVED","isRequired":true,"uniqueKey":"deposit.failureReason.failureCode","typeLabel":"string"},"failureMessage":{"type":"string","description":"Human readable description of the payment attempt failure.","example":"The payer did not approve the payment.","uniqueKey":"deposit.failureReason.failureMessage","typeLabel":"string"}},"uniqueKey":"deposit.failureReason","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","uniqueKey":"deposit.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","uniqueKey":"deposit.currency","typeLabel":"string"},"country":{"type":"string","minLength":3,"maxLength":3,"description":"The country in which the payment was initiated.\n\nFormat is ISO 3166-1 alpha-3, three character country code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements).\n","example":"ZMB","uniqueKey":"deposit.country","typeLabel":"string"},"payer":{"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":"deposit.payer.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":"deposit.payer.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":"deposit.payer.accountDetails.provider","typeLabel":"string"}},"isRequired":true,"uniqueKey":"deposit.payer.accountDetails","typeLabel":"object"}},"uniqueKey":"deposit.payer","typeLabel":"object"},"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":"deposit.customerMessage","typeLabel":"string"},"metadata":{"description":"The metadata that was provided in the original initation request in a JSON object format.\n","type":"object","properties":{"additionalProperties":{"type":"string","description":"Each passed in metadata field will be a property of the metadata JSON object.","uniqueKey":"deposit.metadata.\\additionalProperties","typeLabel":"string"}},"example":{"orderId":"ORD-123456789","customerId":"customer@email.com"},"uniqueKey":"deposit.metadata","typeLabel":"object"}},"uniqueKey":"deposit","typeLabel":"object"},"reason":{"type":"object","description":"Localized reason values shown to the customer inside the hosted payment page.","additionalProperties":{"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":"reason.additionalProperties","typeLabel":"string"},"example":{"en":"GOODS PURCHASE"},"uniqueKey":"reason","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"checkoutId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","created":"2020-02-21T17:32:29Z","depositsHistory":[{"depositId":"f4401bd2-1568-4140-bf2d-eb77d2b2b639","created":"2020-02-21T17:32:29Z","providerTransactionId":"ABC123","amount":"15","currency":"ZMW","country":"ZMB","customerMessage":"Note of 4 to 22 chars","metadata":{"orderId":"ORD-123456789","customerId":"customer@email.com"}}],"metadata":{"orderId":"ORD-123456789","customerId":"customer@email.com"},"checkoutCode":"7mVk1x8UbTamQ64xGR","returnUrl":"https://merchant.example.com/checkout-result","countries":["ZMB","CIV"],"amounts":[{"country":"ZMB","currency":"ZMW","amount":"15"}],"clientReferenceId":"INV-123456","providerTransactionId":"ABC123","reason":{"en":"GOODS PURCHASE"}}}},"originalFileLocation":"v2/api-reference/openapi_v2.yaml"},"subdomain":"pawapay","siteName":"PawaPay Merchant API","title":"Checkout callback - PawaPay Merchant API","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/api-reference/checkouts/checkout-callback","matchLevel":0},"v1":{"href":"/getting_started","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T15:22:38.731Z","originalFileLocation":"v2/api-reference/checkouts/checkout-callback.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.\">\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=\"Checkout callback - PawaPay Merchant API\">\u003cmeta data-mint-head property=\"og:description\" content=\"API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.\">\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/checkouts/checkout-callback\">\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=Checkouts\u0026amp;title=Checkout+callback\u0026amp;description=API+reference%3A+the+callback+PawaPay+sends+when+a+checkout+is+COMPLETED%2C+FAILED%2C+EXPIRED+or+CANCELLED%2C+with+every+payment+attempt.\u0026amp;theme=6df4a9d744128cd68aba8e91\u0026amp;signature=ef092c1af2dadd89f8d0987d5f1b94a73a809558ed62bb6a6df623b013a93208\">\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=\"Checkout callback - PawaPay Merchant API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pawapay.mintlify.site/_mintlify/api/og/v2?division=Checkouts\u0026amp;title=Checkout+callback\u0026amp;description=API+reference%3A+the+callback+PawaPay+sends+when+a+checkout+is+COMPLETED%2C+FAILED%2C+EXPIRED+or+CANCELLED%2C+with+every+payment+attempt.\u0026amp;theme=6df4a9d744128cd68aba8e91\u0026amp;signature=ef092c1af2dadd89f8d0987d5f1b94a73a809558ed62bb6a6df623b013a93208\">\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/checkouts/checkout-callback\">\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/checkouts/checkout-callback.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/checkouts/checkout-callback#webpage\",\"url\":\"https://docs.pawapay.io/v2/api-reference/checkouts/checkout-callback\",\"name\":\"Checkout callback\",\"description\":\"API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.\",\"dateModified\":\"2026-11-11T15:22:38.731Z\",\"isPartOf\":{\"@id\":\"https://docs.pawapay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pawapay.io/v2/api-reference/checkouts/checkout-callback#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pawapay.io/v2/api-reference/checkouts/checkout-callback#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Checkouts\",\"item\":\"https://docs.pawapay.io/v2/api-reference/checkouts/initiate-checkout\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Checkout callback\",\"item\":\"https://docs.pawapay.io/v2/api-reference/checkouts/checkout-callback\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pawapay.io/v2/api-reference/checkouts/checkout-callback#apireference\",\"headline\":\"Checkout callback\",\"name\":\"Checkout callback\",\"description\":\"API reference: the callback PawaPay sends when a checkout is COMPLETED, FAILED, EXPIRED or CANCELLED, with every payment attempt.\",\"url\":\"https://docs.pawapay.io/v2/api-reference/checkouts/checkout-callback\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pawapay.io/v2/api-reference/checkouts/checkout-callback#webpage\"},\"dateModified\":\"2026-11-11T15:22:38.731Z\",\"publisher\":{\"@id\":\"https://docs.pawapay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pawapay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PawaPay Merchant API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PawaPay Merchant API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v2/api-reference/checkouts/checkout-callback.md","siteName":"PawaPay Merchant API","nav":{"global":{"anchors":[{"anchor":"Run in Postman","icon":"circle-play","href":"https://app.getpostman.com/run-collection/25129489-56cbaf62-56c2-4734-bf1f-f61d369cc9e3?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D25129489-56cbaf62-56c2-4734-bf1f-f61d369cc9e3%26entityType%3Dcollection%26workspaceId%3D8c3e7775-3da5-4bab-8a8c-ffb331ccfe27"}]},"versions":[{"version":"v2","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","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","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","description":"API reference: expire a PawaPay checkout so the customer can no longer make new payment attempts on it.","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","description":"API reference: start a deposit on the PawaPay hosted Payment Page and get the redirectURL to send your customer to (API v2).","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":"/getting_started"}]}]},"basePath":"","title":"Checkout callback - PawaPay Merchant API","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}