Unique identifier for this API request. Include in support tickets.
Example:
"c1b2a3d4-e5f6-7890-abcd-ef1234567890"
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"PalPluss","colors":{"primary":"#111111","light":"#6B7280","dark":"#000000"},"favicon":"https://mintcdn.com/palpluss/kZHKjqPC9l9UMCMk/favicon.svg?fit=max\u0026auto=format\u0026n=kZHKjqPC9l9UMCMk\u0026q=85\u0026s=7bd24c0286fd4ad4d79aded52a0a4dbe","logo":{"light":"https://mintcdn.com/palpluss/kZHKjqPC9l9UMCMk/logo/light.svg?fit=max\u0026auto=format\u0026n=kZHKjqPC9l9UMCMk\u0026q=85\u0026s=ce6b865a958dcdf5e1c2230c23349c44","dark":"https://mintcdn.com/palpluss/kZHKjqPC9l9UMCMk/logo/dark.svg?fit=max\u0026auto=format\u0026n=kZHKjqPC9l9UMCMk\u0026q=85\u0026s=9bbfe7cf49d54d384f102e9eedfed742"},"api":{"openapi":"openapi.yaml","mdx":{"server":"https://api.palpluss.com/v1","auth":{"method":"basic","name":null}}},"navbar":{"links":[{"label":"Support","href":"mailto:developer@palpluss.com"}],"primary":{"type":"button","label":"Console","href":"https://console.palpluss.com"}},"footer":{"socials":{"website":"https://palpluss.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"palpluss","hasAudioNarration":false,"actualSubdomain":"palpluss","customDomains":["docs.palpluss.com"],"gitSource":{"type":"github","owner":"bazarintech","repo":"palpluss-backend","deployBranch":"main","contentDirectory":"docs/portal","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada0fa525e5b97c636972ea","collectionId":"c2b359a3-43f1-4aa5-8a7f-2f6ea7e2c2fc","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada0fa525e5b97c636972ea"},"entitlements":{},"buildId":"6ada0fa525e5b97c636972ea","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Payment Channels","count":5},{"language":"default","tag":"SDKs","count":5},{"language":"default","tag":"Guides","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Transactions","count":2},{"language":"default","tag":"Service Wallet","count":2},{"language":"default","tag":"B2C Payouts","count":1},{"language":"default","tag":"STK Push","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/transactions/get","slug":"/api-reference/transactions/get","pageMetadata":{"title":"Get Transaction","openapi":"GET /transactions/{id}","description":"Retrieve the full details of a single transaction by its ID.","href":"/api-reference/transactions/get"},"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: \"Retrieve the full details of a single transaction by its ID.\"\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`,li:`li`,ol:`ol`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Retrieve a transaction by ID. Use this to confirm status, display details, or reconcile payments.`}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Use webhooks as your primary mechanism for receiving payment results. Poll this endpoint only when webhook delivery has failed.`})}),`\n`,_jsx(Heading,{level:`2`,id:`when-to-use-this-endpoint`,children:`When to use this endpoint`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Confirm final status when webhooks are unavailable`}),`\n`,_jsx(_components.li,{children:`Display transaction details in your application`}),`\n`,_jsx(_components.li,{children:`Reconcile payments against internal records`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`transaction_id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Transaction UUID`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`type`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`STK`}),` or `,_jsx(_components.code,{children:`B2C`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Current status — see `,_jsx(_components.a,{href:`/guides/transaction-lifecycle`,children:`transaction lifecycle`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`amount`})}),_jsx(_components.td,{children:`number`}),_jsx(_components.td,{children:`Transaction amount in KES`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`currency`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Always `,_jsx(_components.code,{children:`\"KES\"`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`phone_number`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Normalised phone (`,_jsx(_components.code,{children:`254XXXXXXXXX`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`external_reference`})}),_jsx(_components.td,{children:`string | null`}),_jsxs(_components.td,{children:[`Your `,_jsx(_components.code,{children:`accountReference`}),` or `,_jsx(_components.code,{children:`reference`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`transaction_fee`})}),_jsx(_components.td,{children:`number`}),_jsxs(_components.td,{children:[`Service wallet fee charged. Returned for `,_jsx(_components.code,{children:`PENDING`}),` and `,_jsx(_components.code,{children:`SUCCESS`}),` only — `,_jsx(_components.code,{children:`0`}),` for all other statuses.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`provider_request_id`})}),_jsx(_components.td,{children:`string | null`}),_jsx(_components.td,{children:`Provider request reference`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`provider_checkout_id`})}),_jsx(_components.td,{children:`string | null`}),_jsx(_components.td,{children:`Provider checkout / conversation ID`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`result_code`})}),_jsx(_components.td,{children:`string | null`}),_jsx(_components.td,{children:`Provider result code`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`result_desc`})}),_jsx(_components.td,{children:`string | null`}),_jsx(_components.td,{children:`Provider result description`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`created_at`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`ISO 8601 timestamp`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`updated_at`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`ISO 8601 timestamp`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`polling-strategy`,children:`Polling strategy`}),`\n`,_jsx(_components.p,{children:`After initiating an STK Push:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Wait 15 seconds — most customers respond within this window.`}),`\n`,_jsxs(_components.li,{children:[`Poll every 10 seconds while status is `,_jsx(_components.code,{children:`PENDING`}),` or `,_jsx(_components.code,{children:`PROCESSING`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Stop when a terminal state is reached: `,_jsx(_components.code,{children:`SUCCESS`}),`, `,_jsx(_components.code,{children:`FAILED`}),`, `,_jsx(_components.code,{children:`CANCELLED`}),`, or `,_jsx(_components.code,{children:`REVERSED`}),`.`]}),`\n`,_jsx(_components.li,{children:`After 5 minutes without a terminal state, treat the transaction as likely failed.`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Excessive polling consumes your rate limit. For real-time results, use `,_jsx(_components.a,{href:`/guides/webhooks`,children:`webhooks`}),`.`]})]})}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":"Get Transaction","openapi":"GET /transactions/{id}","description":"Retrieve the full details of a single transaction by its ID.","href":"/api-reference/transactions/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"When to use this endpoint","slug":"when-to-use-this-endpoint","depth":2,"children":[]},{"title":"Response fields","slug":"response-fields","depth":2,"children":[]},{"title":"Polling strategy","slug":"polling-strategy","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getTransaction","summary":"Get transaction","description":"Retrieve the full details of a single transaction by its ID.","tags":["Transactions"],"parameters":["242fb283-2966-480a-8706-c70fc8985daa"],"responses":{"200":"593a1737-42bf-40c8-a4f6-09376d53b4ec","401":"0a9652db-9f6e-422b-ac01-c1f89c0b024c","404":"345a64ce-ff64-491a-996f-c70a8d920ba4","429":"710ae64f-1837-471d-bfb0-f1dd3740aff4"},"method":"get","type":"path","servers":["718a5a31-5732-404a-9483-3b195f06ddaa","48398f67-2f51-42fd-b67c-a18002d4e450"],"security":["edae0e84-8f74-41f5-a3a0-5f0801352ccf"],"path":"/transactions/{id}","baseUrlOptions":["https://api.palpluss.com/v1","https://sandbox.palpluss.com/v1"],"title":"Get transaction","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"242fb283-2966-480a-8706-c70fc8985daa":{"name":"id","in":"path","required":true,"description":"The transaction ID returned when the payment was initiated.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The transaction ID returned when the payment was initiated.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"593a1737-42bf-40c8-a4f6-09376d53b4ec":{"description":"Transaction details.","content":{"application/json":{"schema":{"type":"object","required":["success","data","requestId"],"properties":{"success":{"type":"boolean","example":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","description":"Response payload. Shape varies by endpoint.","properties":{"transactionId":{"type":"string","format":"uuid","description":"Unique transaction identifier.","uniqueKey":"data.transactionId","typeLabel":"string\u003cuuid>"},"tenantId":{"type":"string","format":"uuid","uniqueKey":"data.tenantId","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["STK","B2C"],"description":"- `STK` — M-Pesa STK Push collection\n- `B2C` — Business to Customer payout\n","uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["PENDING","PROCESSING","SUCCESS","FAILED","REVERSED","CANCELLED"],"description":"- `PENDING` — Awaiting customer action or provider response\n- `PROCESSING` — Provider accepted; waiting for final confirmation\n- `SUCCESS` — Completed successfully\n- `FAILED` — Transaction failed (provider declined or timeout)\n- `REVERSED` — Successfully reversed (wallet credited back)\n- `CANCELLED` — Cancelled before processing\n","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","format":"decimal","description":"Transaction amount in KES.","example":1000,"uniqueKey":"data.amount","typeLabel":"number\u003cdecimal>"},"currency":{"type":"string","example":"KES","uniqueKey":"data.currency","typeLabel":"string"},"phone":{"type":"string","description":"Customer phone in `254XXXXXXXXX` format.","example":"254712345678","uniqueKey":"data.phone","typeLabel":"string"},"channelId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.channelId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.channelId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channelId","typeLabel":"string\u003cuuid> | null"},"accountReference":{"oneOf":[{"type":"string","description":"Reference you supplied (STK) or external reference (B2C).","example":"INV-2024-001","uniqueKey":"data.accountReference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reference you supplied (STK) or external reference (B2C).","example":"INV-2024-001","uniqueKey":"data.accountReference.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.accountReference","typeLabel":"string | null"},"transactionDesc":{"oneOf":[{"type":"string","example":"Payment for invoice #2024-001","uniqueKey":"data.transactionDesc.oneOf.0","typeLabel":"string"},{"type":"null","example":"Payment for invoice #2024-001","uniqueKey":"data.transactionDesc.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.transactionDesc","typeLabel":"string | null"},"provider":{"oneOf":[{"type":"string","example":"m-pesa","uniqueKey":"data.provider.oneOf.0","typeLabel":"string"},{"type":"null","example":"m-pesa","uniqueKey":"data.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.provider","typeLabel":"string | null"},"providerRequestId":{"oneOf":[{"type":"string","example":"29115-34620561-1","uniqueKey":"data.providerRequestId.oneOf.0","typeLabel":"string"},{"type":"null","example":"29115-34620561-1","uniqueKey":"data.providerRequestId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.providerRequestId","typeLabel":"string | null"},"providerCheckoutId":{"oneOf":[{"type":"string","example":"ws_CO_191220191020363925","uniqueKey":"data.providerCheckoutId.oneOf.0","typeLabel":"string"},{"type":"null","example":"ws_CO_191220191020363925","uniqueKey":"data.providerCheckoutId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.providerCheckoutId","typeLabel":"string | null"},"resultCode":{"oneOf":[{"type":"string","description":"M-Pesa result code. `\"0\"` = success.","example":"0","uniqueKey":"data.resultCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"M-Pesa result code. `\"0\"` = success.","example":"0","uniqueKey":"data.resultCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.resultCode","typeLabel":"string | null"},"resultDesc":{"oneOf":[{"type":"string","example":"The service request is processed successfully.","uniqueKey":"data.resultDesc.oneOf.0","typeLabel":"string"},{"type":"null","example":"The service request is processed successfully.","uniqueKey":"data.resultDesc.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.resultDesc","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this API request. Include in support tickets.","example":"c1b2a3d4-e5f6-7890-abcd-ef1234567890","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"success":{"title":"success","value":{"success":true,"data":{"transactionId":"fa98a577-95ea-4a8f-8467-1fbe74f5d6f4","tenantId":"b6fbe75f-ce87-4d44-b318-6cfdb8b7de4d","type":"STK","status":"SUCCESS","amount":1000,"currency":"KES","phone":"254712345678","channelId":null,"accountReference":"INV-2024-001","transactionDesc":"Payment for invoice #2024-001","provider":"m-pesa","providerRequestId":"29115-34620561-1","providerCheckoutId":"ws_CO_191220191020363925","resultCode":"0","resultDesc":"The service request is processed successfully.","createdAt":"2026-03-01T08:00:00.000Z","updatedAt":"2026-03-01T08:01:30.000Z"},"requestId":"c1b2a3d4-0000-0000-0000-000000000000"}}},"exampleType":"examples"}},"exampleType":"examples"},"0a9652db-9f6e-422b-ac01-c1f89c0b024c":{"description":"Missing, invalid, or revoked API key.","content":{"application/json":{"schema":{"type":"object","required":["success","error","requestId"],"properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","description":"Human-readable error description.","example":"Invalid API key","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code.","example":"INVALID_API_KEY","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"type":"object","description":"Optional structured details about the error.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"requestId":{"type":"string","format":"uuid","example":"c1b2a3d4-e5f6-7890-abcd-ef1234567890","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_key":{"title":"invalid_key","value":{"success":false,"error":{"message":"Invalid or revoked API key.","code":"INVALID_API_KEY","details":{}},"requestId":"a1b2c3d4-0000-0000-0000-000000000000"}}},"exampleType":"examples"}},"exampleType":"examples"},"345a64ce-ff64-491a-996f-c70a8d920ba4":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"type":"object","required":["success","error","requestId"],"properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","description":"Human-readable error description.","example":"Invalid API key","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code.","example":"INVALID_API_KEY","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"type":"object","description":"Optional structured details about the error.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"requestId":{"type":"string","format":"uuid","example":"c1b2a3d4-e5f6-7890-abcd-ef1234567890","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"not_found":{"title":"not_found","value":{"success":false,"error":{"message":"Transaction not found.","code":"TRANSACTION_NOT_FOUND","details":{}},"requestId":"a1b2c3d4-0000-0000-0000-000000000000"}}},"exampleType":"examples"}},"exampleType":"examples"},"710ae64f-1837-471d-bfb0-f1dd3740aff4":{"description":"Rate limit exceeded — 60 requests per minute per API key.","headers":{"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Maximum requests per minute."},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Remaining requests in the current window."},"x-ratelimit-reset":{"schema":{"type":"integer"},"description":"Unix timestamp when the window resets."},"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait before retrying."}},"content":{"application/json":{"schema":{"type":"object","required":["success","error","requestId"],"properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","description":"Human-readable error description.","example":"Invalid API key","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code.","example":"INVALID_API_KEY","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"type":"object","description":"Optional structured details about the error.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"requestId":{"type":"string","format":"uuid","example":"c1b2a3d4-e5f6-7890-abcd-ef1234567890","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"rate_limited":{"title":"rate_limited","value":{"success":false,"error":{"message":"Rate limit exceeded. Try again in 12 seconds.","code":"RATE_LIMIT_EXCEEDED","details":{"limit":60,"remaining":0,"resetInSeconds":12}},"requestId":"a1b2c3d4-0000-0000-0000-000000000000"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"edae0e84-8f74-41f5-a3a0-5f0801352ccf":{"BasicAuth":{"type":"http","scheme":"basic","description":"Paste your PalPluss API key in the **username** field and leave the\n**password** field empty — it is ignored.\n\nGet your key from **console → Settings → API Keys** (starts with `pk_live_` or `pk_test_`).\n\nIn your own code, send the key directly:\n`Authorization: Basic YOUR_API_KEY`\n","scopes":[]}}},"servers":{"718a5a31-5732-404a-9483-3b195f06ddaa":{"url":"https://api.palpluss.com/v1","description":"Production"},"48398f67-2f51-42fd-b67c-a18002d4e450":{"url":"https://sandbox.palpluss.com/v1","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Paste your PalPluss API key in the **username** field and leave the\n**password** field empty — it is ignored.\n\nGet your key from **console → Settings → API Keys** (starts with `pk_live_` or `pk_test_`).\n\nIn your own code, send the key directly:\n`Authorization: Basic YOUR_API_KEY`\n","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Paste your PalPluss API key in the **username** field and leave the\n**password** field empty — it is ignored.\n\nGet your key from **console → Settings → API Keys** (starts with `pk_live_` or `pk_test_`).\n\nIn your own code, send the key directly:\n`Authorization: Basic YOUR_API_KEY`\n","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"palpluss","siteName":"PalPluss","title":"Get Transaction - PalPluss","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-24T16:51:37.302Z","originalFileLocation":"api-reference/transactions/get.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=\"Retrieve the full details of a single transaction by its ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PalPluss\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/palpluss/msXY76fYdJK8mUx_/_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/palpluss/msXY76fYdJK8mUx_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/palpluss/msXY76fYdJK8mUx_/_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/palpluss/msXY76fYdJK8mUx_/_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/palpluss/msXY76fYdJK8mUx_/_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/palpluss/msXY76fYdJK8mUx_/_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/palpluss/msXY76fYdJK8mUx_/_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/palpluss/msXY76fYdJK8mUx_/_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/palpluss/msXY76fYdJK8mUx_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Transaction - PalPluss\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve the full details of a single transaction by its ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PalPluss\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.palpluss.com/api-reference/transactions/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://palpluss.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Get+Transaction\u0026amp;description=Retrieve+the+full+details+of+a+single+transaction+by+its+ID.\u0026amp;theme=1eaa1abcfd99f02a4320e063\u0026amp;signature=8051661ae12703fb9c9dd801c6e928b8db864c3a37d0034009ee7212b078c2d0\">\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=\"Get Transaction - PalPluss\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve the full details of a single transaction by its ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://palpluss.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Get+Transaction\u0026amp;description=Retrieve+the+full+details+of+a+single+transaction+by+its+ID.\u0026amp;theme=1eaa1abcfd99f02a4320e063\u0026amp;signature=8051661ae12703fb9c9dd801c6e928b8db864c3a37d0034009ee7212b078c2d0\">\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/palpluss/msXY76fYdJK8mUx_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PalPluss\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.palpluss.com/api-reference/transactions/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/transactions/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.palpluss.com/#organization\",\"name\":\"PalPluss\",\"url\":\"https://docs.palpluss.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/palpluss/kZHKjqPC9l9UMCMk/logo/light.svg?fit=max\u0026auto=format\u0026n=kZHKjqPC9l9UMCMk\u0026q=85\u0026s=ce6b865a958dcdf5e1c2230c23349c44\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.palpluss.com#website\",\"name\":\"PalPluss\",\"url\":\"https://docs.palpluss.com\",\"publisher\":{\"@id\":\"https://docs.palpluss.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.palpluss.com/api-reference/transactions/get#webpage\",\"url\":\"https://docs.palpluss.com/api-reference/transactions/get\",\"name\":\"Get Transaction\",\"description\":\"Retrieve the full details of a single transaction by its ID.\",\"dateModified\":\"2026-03-24T16:51:37.302Z\",\"isPartOf\":{\"@id\":\"https://docs.palpluss.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.palpluss.com/api-reference/transactions/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.palpluss.com/api-reference/transactions/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Transactions\",\"item\":\"https://docs.palpluss.com/api-reference/transactions/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Transaction\",\"item\":\"https://docs.palpluss.com/api-reference/transactions/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.palpluss.com/api-reference/transactions/get#apireference\",\"headline\":\"Get Transaction\",\"name\":\"Get Transaction\",\"description\":\"Retrieve the full details of a single transaction by its ID.\",\"url\":\"https://docs.palpluss.com/api-reference/transactions/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.palpluss.com/api-reference/transactions/get#webpage\"},\"dateModified\":\"2026-03-24T16:51:37.302Z\",\"publisher\":{\"@id\":\"https://docs.palpluss.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.palpluss.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PalPluss\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"PalPluss","nav":{"global":null,"groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Going Live","href":"/guides/going-live"}]},{"group":"Guides","pages":[{"title":"Authentication","href":"/guides/authentication"},{"title":"Transaction Lifecycle","href":"/guides/transaction-lifecycle"},{"title":"Webhooks","href":"/guides/webhooks"},{"title":"Errors","href":"/guides/errors"}]},{"group":"SDKs","pages":[{"title":"SDK Overview","href":"/sdks/overview"},{"title":"TypeScript SDK","href":"/sdks/typescript"},{"title":"Python SDK","href":"/sdks/python"},{"title":"PHP SDK","href":"/sdks/php"},{"title":"Paylink Widget","href":"/sdks/paylink"}]},{"group":"STK Push","pages":[{"title":"Initiate STK Push","openapi":"POST /payments/stk","href":"/api-reference/stk/initiate"}]},{"group":"Transactions","pages":[{"title":"List Transactions","openapi":"GET /transactions","description":"Retrieve a paginated list of transactions for your account.","href":"/api-reference/transactions/list"},{"title":"Get Transaction","openapi":"GET /transactions/{id}","href":"/api-reference/transactions/get"}]},{"group":"B2C Payouts","pages":[{"title":"Initiate B2C Payout","openapi":"POST /b2c/payouts","description":"Send money directly to a customer's M-Pesa mobile number.","href":"/api-reference/b2c/payout"}]},{"group":"Service Wallet","pages":[{"title":"Get Service Wallet Balance","openapi":"GET /wallets/service/balance","href":"/api-reference/wallets/balance"},{"title":"Top Up Service Wallet","openapi":"POST /wallets/service/topups","href":"/api-reference/wallets/topup"}]},{"group":"Payment Channels","pages":[{"title":"List Payment Channels","openapi":"GET /payment-wallet/channels","href":"/api-reference/channels/list"},{"title":"Get Payment Channel","openapi":"GET /payment-wallet/channels/{id}","href":"/api-reference/channels/get"},{"title":"Create Payment Channel","openapi":"POST /payment-wallet/channels","href":"/api-reference/channels/create"},{"title":"Update Payment Channel","openapi":"PATCH /payment-wallet/channels/{id}","href":"/api-reference/channels/update"},{"title":"Delete Payment Channel","openapi":"DELETE /payment-wallet/channels/{id}","href":"/api-reference/channels/delete"}]}]},"title":"Get Transaction - PalPluss","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}