{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PIED API","colors":{"primary":"#7A2BEF","light":"#8800FF","dark":"#7A2BEF"},"logo":{"light":"https://mintcdn.com/pied-3a231858/srnY5TMUiKfzvm-Y/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=srnY5TMUiKfzvm-Y\u0026q=85\u0026s=bf6f5b58ad371d63853387ff87e07cc6","dark":"https://mintcdn.com/pied-3a231858/srnY5TMUiKfzvm-Y/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=srnY5TMUiKfzvm-Y\u0026q=85\u0026s=0f7090387596567ccfd597f59121812b","href":"https://docs.pied.com.br/docs/introduction"},"favicon":"https://mintcdn.com/pied-3a231858/srnY5TMUiKfzvm-Y/icone.svg?fit=max\u0026auto=format\u0026n=srnY5TMUiKfzvm-Y\u0026q=85\u0026s=53cc079759c2963208ea63d872b3c2c2","api":{"mdx":{"auth":{"method":"bearer"}}},"navbar":{"primary":{"type":"button","label":"Central de ajuda","href":"https://suportepied.tawk.help/"}},"footer":{"socials":{"website":"https://pied.com.br","linkedin":"https://www.linkedin.com/company/pietatech?originalSubdomain=br","instagram":"https://www.instagram.com/pieta.tech"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Nosso site","icon":"earth-americas","href":"https://pied.com.br"},{"anchor":"Central de ajuda","icon":"circle-question","href":"https://suportepied.tawk.help/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pied-3a231858","hasAudioNarration":false,"actualSubdomain":"pied-3a231858","customDomains":["docs.pied.com.br"],"gitSource":{"type":"github","owner":"pied-software","repo":"pied-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad22ad995906ab85f64eee1","collectionId":"fb243472-6c68-44d3-892f-f1b693dec311","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad22ad995906ab85f64eee1"},"entitlements":{},"buildId":"6ad22ad995906ab85f64eee1","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Comentários","count":7},{"language":"default","tag":"Requests","count":6},{"language":"default","tag":"Tarefas","count":5},{"language":"default","tag":"Integrações","count":5},{"language":"default","tag":"Pagamentos","count":4},{"language":"default","tag":"Empresas","count":3},{"language":"default","tag":"Equipamentos","count":3},{"language":"default","tag":"Plataformas de Automação","count":3},{"language":"default","tag":"Colaboradores","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2/payment/get-payment","slug":"/api-reference/v2/payment/get-payment","pageMetadata":{"title":"Retorna detalhes do pagamento","openapi":"openapi/openapi-v2.json GET /payments/{paymentId}","description":null,"href":"/api-reference/v2/payment/get-payment"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`🚀 API v2 (Recomendada)`}),` - Use este endpoint para novos projetos`]})})}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":"Retorna detalhes do pagamento","openapi":"openapi/openapi-v2.json GET /payments/{paymentId}","description":null,"href":"/api-reference/v2/payment/get-payment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["2ca257b4-72fb-4cb5-b474-04a5ab1b10fe"],"tags":["Payments"],"summary":"Retorna detalhes do pagamento","parameters":["998d7913-309a-4e74-aceb-e3bc7f09472d"],"responses":{"200":"9a9203d4-c019-4392-a407-679786e14c5f","429":"27fd0871-b7d5-403d-90a0-252b9dad02f7","500":"09f4d833-03c2-41e3-9f73-3f534b579944"},"method":"get","type":"path","servers":["3fac26e0-8dcf-42c3-945a-4c630c695244"],"path":"/payments/{paymentId}","baseUrlOptions":["https://backend-pied-prod.piedadmin.com.br/api/v2"],"title":"Retorna detalhes do pagamento","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"998d7913-309a-4e74-aceb-e3bc7f09472d":{"name":"paymentId","in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"responses":{"9a9203d4-c019-4392-a407-679786e14c5f":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["pix","boleto","debito","credito","financiamento","other"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"condition":{"type":"object","properties":{"name":{"type":"string","example":"À vista","uniqueKey":"condition.name","typeLabel":"string"},"quantityOfInstallments":{"type":"number","example":1,"uniqueKey":"condition.quantityOfInstallments","typeLabel":"number"},"conditionType":{"type":"string","enum":["notUpdate","increase","decrease"],"uniqueKey":"condition.conditionType","typeLabel":"enum\u003cstring>"},"modifierType":{"type":"string","enum":["percentage","fixed"],"uniqueKey":"condition.modifierType","typeLabel":"enum\u003cstring>"},"value":{"type":"number","example":10,"uniqueKey":"condition.value","typeLabel":"number"}},"uniqueKey":"condition","typeLabel":"object"},"transactionStatus":{"type":"string","enum":["pending","pre_approved","approved","canceled","voided","failed","unknown"],"example":"pending","uniqueKey":"transactionStatus","typeLabel":"enum\u003cstring>"},"transactionId":{"type":"string","example":"AAABBB123AA","uniqueKey":"transactionId","typeLabel":"string"},"authorizationNsu":{"type":"string","example":"123123","uniqueKey":"authorizationNsu","typeLabel":"string"},"authorizationCode":{"type":"string","example":"123123","uniqueKey":"authorizationCode","typeLabel":"string"},"paidAt":{"type":"string","example":"2025-01-01T00:00","uniqueKey":"paidAt","typeLabel":"string"},"creditCard":{"type":"object","properties":{"brand":{"type":"string","example":"visa","uniqueKey":"creditCard.brand","typeLabel":"string"},"last4digits":{"type":"string","example":"1234","uniqueKey":"creditCard.last4digits","typeLabel":"string"},"first6digits":{"type":"string","example":"123456","uniqueKey":"creditCard.first6digits","typeLabel":"string"},"holderName":{"type":"string","example":"John Doe","uniqueKey":"creditCard.holderName","typeLabel":"string"}},"uniqueKey":"creditCard","typeLabel":"object"},"total":{"type":"number","uniqueKey":"total","typeLabel":"number"},"subtotal":{"type":"number","uniqueKey":"subtotal","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"pix","condition":{"name":"À vista","quantityOfInstallments":1,"conditionType":"notUpdate","modifierType":"percentage","value":10},"transactionStatus":"pending","transactionId":"AAABBB123AA","authorizationNsu":"123123","authorizationCode":"123123","paidAt":"2025-01-01T00:00","creditCard":{"brand":"visa","last4digits":"1234","first6digits":"123456","holderName":"John Doe"},"total":123,"subtotal":123}}},"exampleType":"generated"}},"exampleType":"generated"},"27fd0871-b7d5-403d-90a0-252b9dad02f7":{"description":"hardLimit: O limite de requisições por hora foi ultrapassado. Tente novamente mais tarde / timeLimit: O limite de 1 minuto de processamento de requisição por hora foi atingido. Tente novamente mais tarde","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"09f4d833-03c2-41e3-9f73-3f534b579944":{"description":"Erro na API","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"2ca257b4-72fb-4cb5-b474-04a5ab1b10fe":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"3fac26e0-8dcf-42c3-945a-4c630c695244":{"url":"https://backend-pied-prod.piedadmin.com.br/api/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/openapi-v2.json"},"subdomain":"pied-3a231858","siteName":"PIED API","title":"Retorna detalhes do pagamento - PIED API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T13:47:13.290Z","originalFileLocation":"api-reference/v2/payment/get-payment.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=\"PIED 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/pied-3a231858/CwY_i3PbErUauq7j/_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/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_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/pied-3a231858/CwY_i3PbErUauq7j/_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/pied-3a231858/CwY_i3PbErUauq7j/_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/pied-3a231858/CwY_i3PbErUauq7j/_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/pied-3a231858/CwY_i3PbErUauq7j/_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/pied-3a231858/CwY_i3PbErUauq7j/_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/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retorna detalhes do pagamento - PIED API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PIED API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pied.com.br/api-reference/v2/payment/get-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pied-3a231858.mintlify.app/_mintlify/api/og/v2?division=Pagamentos\u0026amp;title=Retorna+detalhes+do+pagamento\u0026amp;theme=7b2b4449c507a18d7354d695\u0026amp;signature=2b09f40b2996b22483576b048ff3a246ec31caa985ab0d1670a62bdc9ee61d71\">\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=\"Retorna detalhes do pagamento - PIED API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pied-3a231858.mintlify.app/_mintlify/api/og/v2?division=Pagamentos\u0026amp;title=Retorna+detalhes+do+pagamento\u0026amp;theme=7b2b4449c507a18d7354d695\u0026amp;signature=2b09f40b2996b22483576b048ff3a246ec31caa985ab0d1670a62bdc9ee61d71\">\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/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PIED API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7A2BEF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pied.com.br/api-reference/v2/payment/get-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/payment/get-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pied.com.br/#organization\",\"name\":\"PIED API\",\"url\":\"https://docs.pied.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pied-3a231858/srnY5TMUiKfzvm-Y/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=srnY5TMUiKfzvm-Y\u0026q=85\u0026s=bf6f5b58ad371d63853387ff87e07cc6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pied.com.br#website\",\"name\":\"PIED API\",\"url\":\"https://docs.pied.com.br\",\"publisher\":{\"@id\":\"https://docs.pied.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payment#webpage\",\"url\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payment\",\"name\":\"Retorna detalhes do pagamento\",\"dateModified\":\"2026-10-16T13:47:13.290Z\",\"isPartOf\":{\"@id\":\"https://docs.pied.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pagamentos\",\"item\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retorna detalhes do pagamento\",\"item\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payment#apireference\",\"headline\":\"Retorna detalhes do pagamento\",\"name\":\"Retorna detalhes do pagamento\",\"url\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pied.com.br/api-reference/v2/payment/get-payment#webpage\"},\"dateModified\":\"2026-10-16T13:47:13.290Z\",\"publisher\":{\"@id\":\"https://docs.pied.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pied.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PIED API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"PIED API","nav":{"global":{"anchors":[{"anchor":"Nosso site","icon":"earth-americas","href":"https://pied.com.br"},{"anchor":"Central de ajuda","icon":"circle-question","href":"https://suportepied.tawk.help/"}]},"tabs":[{"tab":"Documentação","icon":"book","pages":[{"title":"Documentação","href":"/docs/introduction"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Visão Geral","pages":[{"title":"Visão Geral da API","href":"/api-reference/v2/overview"}]},{"group":"Requests","pages":[{"title":"Retorna os dados dos orçamentos ou dos pedidos","openapi":"openapi/openapi-v2.json GET /requests/{requestType}/{pageNumber}/{pageLimit}","href":"/api-reference/v2/request/get-requests"},{"title":"Atualiza o status do orçamento/pedido","openapi":"openapi/openapi-v2.json PUT /request/updateStatus","href":"/api-reference/v2/request/put-status"},{"title":"Atualiza os dados de pagamento de um pedido","openapi":"openapi/openapi-v2.json PUT /request/{requestCode}/updatePayment","href":"/api-reference/v2/request/put-updatePayment"},{"title":"Retorna o status dos orçamentos/pedidos","openapi":"openapi/openapi-v1.json GET /request/{requestType}/statuses","href":"/api-reference/v1/request/get-statuses"},{"title":"Exclui o orçamento/pedido","openapi":"openapi/openapi-v1.json DELETE /request/{requestCode}","href":"/api-reference/v1/request/delete-request"},{"title":"Atualiza o responsável do orçamento/pedido","openapi":"openapi/openapi-v1.json PUT /request/{requestCode}/responsible","href":"/api-reference/v1/request/put-responsible"}]},{"group":"Empresas","pages":[{"title":"Cria uma ou mais empresas de energia","openapi":"openapi/openapi-v2.json POST /company","href":"/api-reference/v2/company/post-company"},{"title":"Retorna os dados das empresas de energia","openapi":"openapi/openapi-v1.json GET /companies/{pageNumber}/{pageLimit}","href":"/api-reference/v1/company/get-companies"},{"title":"Retorna os dados completos da empresa de energia solar","openapi":"openapi/openapi-v1.json GET /company/{companyMainContactEmail}","href":"/api-reference/v1/company/get-company"}]},{"group":"Equipamentos","pages":[{"title":"Retorna informações sobre os equipamentos","openapi":"openapi/openapi-v2.json GET /equipments/{pageNumber}/{pageLimit}","href":"/api-reference/v2/equipment/get-equipments"},{"title":"Atualiza o preço base e de custo de um ou mais equipamentos","openapi":"openapi/openapi-v2.json PUT /equipments/price","href":"/api-reference/v2/equipment/put-price"},{"title":"Atualiza o estoque dos produtos","openapi":"openapi/openapi-v1.json PUT /equipments/stock","href":"/api-reference/v1/equipment/put-stock"}]},{"group":"Colaboradores","pages":[{"title":"Retorna os dados dos colaboradores","openapi":"openapi/openapi-v1.json GET /staffs/{pageNumber}/{pageLimit}","href":"/api-reference/v1/staff/get-staffs"},{"title":"Retorna os dados completos do colaborador","openapi":"openapi/openapi-v1.json GET /staff/{staffEmail}","href":"/api-reference/v1/staff/get-staff"}]},{"group":"Pagamentos","pages":[{"title":"Retorna lista de pagamentos agrupados por pedido","openapi":"openapi/openapi-v2.json GET /payments/{pageNumber}/{pageLimit}","description":null,"href":"/api-reference/v2/payment/get-payments"},{"title":"Retorna detalhes do pagamento","openapi":"openapi/openapi-v2.json GET /payments/{paymentId}","href":"/api-reference/v2/payment/get-payment"},{"title":"Atualiza dados do pagamento","openapi":"openapi/openapi-v2.json PUT /payments/{paymentId}","description":null,"href":"/api-reference/v2/payment/put-payment"},{"title":"Retorna formas de pagamento configuradas na plataforma","openapi":"openapi/openapi-v2.json GET /payment-methods","href":"/api-reference/v2/payment/get-payment-methods"}]},{"group":"Campos Customizados","pages":[{"title":"Retorna campos customizados relacionados a uma entidade","openapi":"openapi/openapi-v2.json GET /custom-fields/{parentType}/{parentId}","href":"/api-reference/v2/customField/get-customFields"},{"title":"Altera valores de campos customizados associados a uma entidade","openapi":"openapi/openapi-v2.json PUT /custom-fields/{parentType}/{parentId}","href":"/api-reference/v2/customField/put-customFields"}]},{"group":"Tarefas","pages":[{"title":"Retorna lista paginada de tarefas do distribuidor","openapi":"openapi/openapi-v2.json GET /task-plans/{pageNumber}/{pageLimit}","href":"/api-reference/v2/taskPlan/get-taskPlans"},{"title":"Retorna detalhes de uma tarefa","openapi":"openapi/openapi-v2.json GET /task-plans/{taskPlanId}","href":"/api-reference/v2/taskPlan/get-taskPlan"},{"title":"Cria uma nova tarefa","openapi":"openapi/openapi-v2.json POST /task-plans","href":"/api-reference/v2/taskPlan/post-taskPlan"},{"title":"Atualiza uma tarefa","openapi":"openapi/openapi-v2.json PUT /task-plans/{taskPlanId}","href":"/api-reference/v2/taskPlan/put-taskPlan"},{"title":"Remove uma tarefa (soft delete)","openapi":"openapi/openapi-v2.json DELETE /task-plans/{taskPlanId}","href":"/api-reference/v2/taskPlan/delete-taskPlan"}]},{"group":"Comentários","pages":[{"title":"Retorna lista paginada de comentários de uma entidade","openapi":"openapi/openapi-v2.json GET /comments/{pageNumber}/{pageLimit}","href":"/api-reference/v2/comment/get-comments"},{"title":"Cria um novo comentário","openapi":"openapi/openapi-v2.json POST /comments","href":"/api-reference/v2/comment/post-comment"},{"title":"Atualiza um comentário","openapi":"openapi/openapi-v2.json PUT /comments/{commentId}","href":"/api-reference/v2/comment/put-comment"},{"title":"Remove um comentário (soft delete)","openapi":"openapi/openapi-v2.json DELETE /comments/{commentId}","href":"/api-reference/v2/comment/delete-comment"},{"title":"Cria uma resposta em um comentário","openapi":"openapi/openapi-v2.json POST /comments/{commentId}/reply","href":"/api-reference/v2/comment/post-comment-reply"},{"title":"Atualiza uma resposta de comentário","openapi":"openapi/openapi-v2.json PUT /comments/{commentId}/reply/{replyId}","href":"/api-reference/v2/comment/put-comment-reply"},{"title":"Remove uma resposta de comentário","openapi":"openapi/openapi-v2.json DELETE /comments/{commentId}/reply/{replyId}","href":"/api-reference/v2/comment/delete-comment-reply"}]},{"group":"Kits","pages":[{"title":"Obter kits disponíveis","openapi":"openapi/kits.json POST /v2/kits","href":"/api-reference/v2/kits/post-kits"},{"title":"Obter filtros disponíveis","openapi":"openapi/kits.json GET /v2/kits/filter","href":"/api-reference/v2/kits/get-kits-filter"}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/introduction"}]},{"tab":"Integrações","icon":"plug","pages":[{"title":"Integrações","href":"/integrations/introduction"}]}]},"basePath":"","title":"Retorna detalhes do pagamento - PIED API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}