{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PawPayments API","colors":{"primary":"#6366F1","light":"#818CF8","dark":"#6366F1"},"logo":{"light":"https://mintcdn.com/pawpaymentsinc/GvUEHrxVBBZGqu1B/logo/light.png?fit=max\u0026auto=format\u0026n=GvUEHrxVBBZGqu1B\u0026q=85\u0026s=e63c9c4d933201f4ef804ee6b424f0df","dark":"https://mintcdn.com/pawpaymentsinc/GvUEHrxVBBZGqu1B/logo/dark.png?fit=max\u0026auto=format\u0026n=GvUEHrxVBBZGqu1B\u0026q=85\u0026s=329208374dd84350bd253aac43332e16","href":"https://pawpayments.com"},"favicon":"https://mintcdn.com/pawpaymentsinc/GvUEHrxVBBZGqu1B/favicon.png?fit=max\u0026auto=format\u0026n=GvUEHrxVBBZGqu1B\u0026q=85\u0026s=f1058fcf9d51a71711e5de8f50095260","navbar":{"links":[{"href":"/plugins/overview","label":"Plugins \u0026 SDKs"},{"href":"https://pawpayments.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get an API key","href":"https://pawpayments.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pawpaymentsinc","hasAudioNarration":false,"actualSubdomain":"pawpaymentsinc","customDomains":["docs.pawpayments.com"],"gitSource":{"type":"github","owner":"pawpayments","repo":"docs","deployBranch":"main","isPrivate":false,"contentDirectory":"","mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af4bfb1775e4ad0c10ecd70","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Plugins \u0026 SDKs","count":8},{"language":"default","tag":"Introduction","count":7},{"language":"default","tag":"Migrate from another provider","count":5},{"language":"default","tag":"Invoices","count":5},{"language":"default","tag":"Payouts","count":4},{"language":"default","tag":"Permanent addresses","count":4},{"language":"default","tag":"Catalog","count":2},{"language":"default","tag":"Merchant","count":2}]},"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":"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":"site-roles","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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":false},"customCss":[]}
{"page":{"pagePath":"api-reference/payouts/get-a-payout-by-id","slug":"/api-reference/payouts/get-a-payout-by-id","pageMetadata":{"title":"Get a payout by id","description":"","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/payouts/{payout_id}","href":"/api-reference/payouts/get-a-payout-by-id","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a payout by id","description":"","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/payouts/{payout_id}","href":"/api-reference/payouts/get-a-payout-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get a payout by id","operationId":"get__api_v2_payouts_{payout_id}","description":"","tags":["Payouts"],"parameters":["7c109a4b-6a76-4788-8f5b-69fc99e0c418"],"responses":{"200":"7df0787f-d26b-4be9-92ba-1ebd010b8e66","400":"0be2a7b7-e0e5-4bbf-98e4-84fd8bd82d8c","401":"2ab3bbf7-3644-4743-9b34-22800c425768","404":"60030cfc-9ce5-4abb-a999-0088705a4fac","422":"13f6f42d-aa3b-4bfe-9d02-9246d5322283"},"method":"get","type":"path","servers":["67ba0a1a-6bda-4cd2-867f-8a352a5d97f3"],"security":["7fe6fa50-6efa-4362-986f-7c08b1521f52"],"path":"/api/v2/payouts/{payout_id}","baseUrlOptions":["https://api.pawpayments.com"],"title":"Get a payout by id","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7c109a4b-6a76-4788-8f5b-69fc99e0c418":{"name":"payout_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique 24-character hex payout id.","uniqueKey":"","typeLabel":"string"},"description":"Unique 24-character hex payout id."}},"responses":{"7df0787f-d26b-4be9-92ba-1ebd010b8e66":{"description":"OK","content":{"application/json":{"schema":{"properties":{"ok":{"const":true,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"result":{"example":{"address":"TXk2Y5...redacted","amount":25,"created_at":1763398900,"currency":"usdt_tron","energy_fee_usd":0.4,"fee":1,"fee_bearer":"merchant","fee_usd":1,"fiat_amount_usd":25,"order_id":"65f1c3a4e8b1c2d3a4b5c6e0","processed_at":1763398930,"ref":"merchant-ref-1","status":"success","tx_hashes":null,"txid":"0x9a8b7c6d..."},"properties":{"order_id":{"title":"Order Id","type":"string","isRequired":true,"uniqueKey":"result.order_id","typeLabel":"string"},"status":{"oneOf":[{"type":"string","title":"Status","description":"One of: first_payout_review, pending, processing, success, failed, cancelled.","uniqueKey":"result.status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","description":"One of: first_payout_review, pending, processing, success, failed, cancelled.","uniqueKey":"result.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.status","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","title":"Address","uniqueKey":"result.address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address","uniqueKey":"result.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.address","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"number","title":"Amount","description":"Amount in `currency`.","uniqueKey":"result.amount.oneOf.0","typeLabel":"number"},{"type":"null","title":"Amount","description":"Amount in `currency`.","uniqueKey":"result.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.amount","typeLabel":"number | null"},"fiat_amount_usd":{"oneOf":[{"type":"number","title":"Fiat Amount Usd","description":"USD-equivalent of `amount` at payout creation time, before withdrawal and energy fees.","uniqueKey":"result.fiat_amount_usd.oneOf.0","typeLabel":"number"},{"type":"null","title":"Fiat Amount Usd","description":"USD-equivalent of `amount` at payout creation time, before withdrawal and energy fees.","uniqueKey":"result.fiat_amount_usd.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.fiat_amount_usd","typeLabel":"number | null"},"debit_usd":{"oneOf":[{"type":"number","title":"Debit Usd","description":"Total USD deducted from merchant balance.","uniqueKey":"result.debit_usd.oneOf.0","typeLabel":"number"},{"type":"null","title":"Debit Usd","description":"Total USD deducted from merchant balance.","uniqueKey":"result.debit_usd.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.debit_usd","typeLabel":"number | null"},"currency":{"oneOf":[{"type":"string","title":"Currency","description":"Asset key (e.g. usdt_tron).","uniqueKey":"result.currency.oneOf.0","typeLabel":"string"},{"type":"null","title":"Currency","description":"Asset key (e.g. usdt_tron).","uniqueKey":"result.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.currency","typeLabel":"string | null"},"ref":{"oneOf":[{"type":"string","title":"Ref","description":"Merchant-supplied reference, defaults to `automatic_payout`.","uniqueKey":"result.ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ref","description":"Merchant-supplied reference, defaults to `automatic_payout`.","uniqueKey":"result.ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.ref","typeLabel":"string | null"},"fee":{"oneOf":[{"type":"number","title":"Fee","description":"Network fee in the asset's units.","uniqueKey":"result.fee.oneOf.0","typeLabel":"number"},{"type":"null","title":"Fee","description":"Network fee in the asset's units.","uniqueKey":"result.fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.fee","typeLabel":"number | null"},"fee_usd":{"oneOf":[{"type":"number","title":"Fee Usd","uniqueKey":"result.fee_usd.oneOf.0","typeLabel":"number"},{"type":"null","title":"Fee Usd","uniqueKey":"result.fee_usd.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.fee_usd","typeLabel":"number | null"},"energy_fee_usd":{"oneOf":[{"type":"number","title":"Energy Fee Usd","description":"Tron energy surcharge in USD (0 outside Tron).","uniqueKey":"result.energy_fee_usd.oneOf.0","typeLabel":"number"},{"type":"null","title":"Energy Fee Usd","description":"Tron energy surcharge in USD (0 outside Tron).","uniqueKey":"result.energy_fee_usd.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.energy_fee_usd","typeLabel":"number | null"},"fee_bearer":{"oneOf":[{"type":"string","title":"Fee Bearer","default":"merchant","enum":["merchant","client"],"uniqueKey":"result.fee_bearer.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Fee Bearer","default":"merchant","uniqueKey":"result.fee_bearer.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.fee_bearer","typeLabel":"enum\u003cstring> | null"},"txid":{"oneOf":[{"type":"string","title":"Txid","description":"Single tx hash for non-batch payouts. Set after broadcast.","uniqueKey":"result.txid.oneOf.0","typeLabel":"string"},{"type":"null","title":"Txid","description":"Single tx hash for non-batch payouts. Set after broadcast.","uniqueKey":"result.txid.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.txid","typeLabel":"string | null"},"tx_hashes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"result.tx_hashes.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Tx Hashes","description":"Multiple tx hashes for EVM batch payouts (one per chunk).","uniqueKey":"result.tx_hashes.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Tx Hashes","description":"Multiple tx hashes for EVM batch payouts (one per chunk).","uniqueKey":"result.tx_hashes.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.tx_hashes","typeLabel":"string[] | null"},"created_at":{"oneOf":[{"type":"integer","title":"Created At","uniqueKey":"result.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Created At","uniqueKey":"result.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.created_at","typeLabel":"integer | null"},"processed_at":{"oneOf":[{"type":"integer","title":"Processed At","description":"Unix timestamp when status flipped from `pending`/`processing`.","uniqueKey":"result.processed_at.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Processed At","description":"Unix timestamp when status flipped from `pending`/`processing`.","uniqueKey":"result.processed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.processed_at","typeLabel":"integer | null"},"voided":{"oneOf":[{"type":"boolean","title":"Voided","description":"True if the payout was voided by an operator and is no longer counted toward the balance.","uniqueKey":"result.voided.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Voided","description":"True if the payout was voided by an operator and is no longer counted toward the balance.","uniqueKey":"result.voided.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.voided","typeLabel":"boolean | null"},"voided_at":{"oneOf":[{"type":"integer","title":"Voided At","uniqueKey":"result.voided_at.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Voided At","uniqueKey":"result.voided_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.voided_at","typeLabel":"integer | null"},"voided_reason":{"oneOf":[{"type":"string","title":"Voided Reason","uniqueKey":"result.voided_reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voided Reason","uniqueKey":"result.voided_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.voided_reason","typeLabel":"string | null"}},"required":["order_id"],"title":"Payout","type":"object","isRequired":true,"uniqueKey":"result","typeLabel":"Payout · object"}},"required":["ok","result"],"title":"PayoutEnvelope","type":"object","uniqueKey":"","typeLabel":"PayoutEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"result":{"address":"TXk2Y5...redacted","amount":25,"created_at":1763398900,"currency":"usdt_tron","energy_fee_usd":0.4,"fee":1,"fee_bearer":"merchant","fee_usd":1,"fiat_amount_usd":25,"order_id":"65f1c3a4e8b1c2d3a4b5c6e0","processed_at":1763398930,"ref":"merchant-ref-1","status":"success","tx_hashes":null,"txid":"0x9a8b7c6d..."}}}},"exampleType":"generated"}},"exampleType":"generated"},"0be2a7b7-e0e5-4bbf-98e4-84fd8bd82d8c":{"description":"Bad Request","content":{"application/json":{"schema":{"example":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false},"properties":{"ok":{"const":false,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"properties":{"code":{"description":"Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"type":"null","title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["ok","error"],"title":"ErrorEnvelope","type":"object","uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false}}},"exampleType":"generated"}},"exampleType":"generated"},"2ab3bbf7-3644-4743-9b34-22800c425768":{"description":"Unauthorized","content":{"application/json":{"schema":{"example":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false},"properties":{"ok":{"const":false,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"properties":{"code":{"description":"Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"type":"null","title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["ok","error"],"title":"ErrorEnvelope","type":"object","uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false}}},"exampleType":"generated"}},"exampleType":"generated"},"60030cfc-9ce5-4abb-a999-0088705a4fac":{"description":"Not Found","content":{"application/json":{"schema":{"example":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false},"properties":{"ok":{"const":false,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"properties":{"code":{"description":"Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"type":"null","title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["ok","error"],"title":"ErrorEnvelope","type":"object","uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false}}},"exampleType":"generated"}},"exampleType":"generated"},"13f6f42d-aa3b-4bfe-9d02-9246d5322283":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"example":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false},"properties":{"ok":{"const":false,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"properties":{"code":{"description":"Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"type":"null","title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["ok","error"],"title":"ErrorEnvelope","type":"object","uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7fe6fa50-6efa-4362-986f-7c08b1521f52":{"ApiKeyAuth":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"67ba0a1a-6bda-4cd2-867f-8a352a5d97f3":{"url":"https://api.pawpayments.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"pawpaymentsinc","siteName":"PawPayments API","title":"Get a payout by id - PawPayments API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T20:49:09.064Z","originalFileLocation":"api-reference/payouts/get-a-payout-by-id.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"PawPayments 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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a payout by id - PawPayments API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PawPayments API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pawpaymentsinc.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Get+a+payout+by+id\u0026amp;theme=e8ae6fe84fd0496427904623\u0026amp;signature=a3b7f85d7e0a967a0adfbe4ee2b5a1d4f886ef21005db42af73bfee9c5822603\">\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 a payout by id - PawPayments API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pawpaymentsinc.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Get+a+payout+by+id\u0026amp;theme=e8ae6fe84fd0496427904623\u0026amp;signature=a3b7f85d7e0a967a0adfbe4ee2b5a1d4f886ef21005db42af73bfee9c5822603\">\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/pawpaymentsinc/MC7gd2QKlNekXMRK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PawPayments API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payouts/get-a-payout-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pawpayments.com/#organization\",\"name\":\"PawPayments API\",\"url\":\"https://docs.pawpayments.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pawpaymentsinc/GvUEHrxVBBZGqu1B/logo/light.png?fit=max\u0026auto=format\u0026n=GvUEHrxVBBZGqu1B\u0026q=85\u0026s=e63c9c4d933201f4ef804ee6b424f0df\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pawpayments.com#website\",\"name\":\"PawPayments API\",\"url\":\"https://docs.pawpayments.com\",\"publisher\":{\"@id\":\"https://docs.pawpayments.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id#webpage\",\"url\":\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id\",\"name\":\"Get a payout by id\",\"dateModified\":\"2026-11-05T20:49:09.064Z\",\"isPartOf\":{\"@id\":\"https://docs.pawpayments.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payouts\",\"item\":\"https://docs.pawpayments.com/api-reference/payouts/list-payouts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a payout by id\",\"item\":\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id#apireference\",\"headline\":\"Get a payout by id\",\"name\":\"Get a payout by id\",\"url\":\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pawpayments.com/api-reference/payouts/get-a-payout-by-id#webpage\"},\"dateModified\":\"2026-11-05T20:49:09.064Z\",\"publisher\":{\"@id\":\"https://docs.pawpayments.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pawpayments.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PawPayments API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PawPayments API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/payouts/get-a-payout-by-id.md","siteName":"PawPayments API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Catalog","pages":[{"title":"List supported assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/assets","href":"/api-reference/catalog/list-supported-assets"},{"title":"Get current exchange rates from cache","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/rates","href":"/api-reference/catalog/get-current-exchange-rates-from-cache"}]},{"group":"Merchant","pages":[{"title":"Get the merchant's balance summary in USD","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/balance","href":"/api-reference/merchant/get-the-merchants-balance-summary-in-usd"},{"title":"Unified income/payout/refund feed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/ledger","href":"/api-reference/merchant/unified-incomepayoutrefund-feed"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Get an invoice by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/invoices/{invoice_id}","href":"/api-reference/invoices/get-an-invoice-by-id"},{"title":"Refund a flagged payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices/{invoice_id}/refund","href":"/api-reference/invoices/refund-a-flagged-payment"},{"title":"Resend the merchant webhook for this invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices/{invoice_id}/notify","href":"/api-reference/invoices/resend-the-merchant-webhook-for-this-invoice"}]},{"group":"Sandbox","pages":[{"title":"Simulate a payment on a sandbox invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices/{invoice_id}/simulate","href":"/api-reference/sandbox/simulate-a-payment-on-a-sandbox-invoice"}]},{"group":"Payouts","pages":[{"title":"List payouts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/payouts","href":"/api-reference/payouts/list-payouts"},{"title":"Create a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/payouts","href":"/api-reference/payouts/create-a-payout"},{"title":"Create a batch of up to 200 payouts. Per-item failures are reported individually","description":"","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/payouts/batch","href":"/api-reference/payouts/create-a-batch-of-up-to-200-payouts-per-item-failures-are-reported-individually"},{"title":"Get a payout by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/payouts/{payout_id}","href":"/api-reference/payouts/get-a-payout-by-id"}]},{"group":"Notifications","pages":[{"title":"List webhook delivery attempts","description":"","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/notifications","href":"/api-reference/notifications/list-webhook-delivery-attempts"},{"title":"Send a test webhook to either `url` from the body or the merchant's callback URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/notifications/test","href":"/api-reference/notifications/send-a-test-webhook-to-either-`url`-from-the-body-or-the-merchants-callback-url"}]},{"group":"Permanent addresses","pages":[{"title":"List permanent deposit addresses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/permanent","href":"/api-reference/permanent-addresses/list-permanent-deposit-addresses"},{"title":"Get-or-create a permanent deposit address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/permanent","href":"/api-reference/permanent-addresses/get-or-create-a-permanent-deposit-address"},{"title":"Get a permanent address by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/permanent/{address_id}","href":"/api-reference/permanent-addresses/get-a-permanent-address-by-id"},{"title":"Deactivate a permanent address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/permanent/{address_id}","href":"/api-reference/permanent-addresses/deactivate-a-permanent-address"}]}]}]},"basePath":"","title":"Get a payout by id - PawPayments API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}