{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Gravity Play","description":"Documentação da API da Gravity Play — crie cobranças, leve ao checkout e receba pagamentos por webhook.","colors":{"primary":"#EA580C","light":"#FB923C","dark":"#F97316"},"logo":{"light":"https://mintcdn.com/gravityplay/b7AIIk7hcK-Pou2a/logo/light.png?fit=max\u0026auto=format\u0026n=b7AIIk7hcK-Pou2a\u0026q=85\u0026s=098c877fccb72289c5e070695f803600","dark":"https://mintcdn.com/gravityplay/b7AIIk7hcK-Pou2a/logo/dark.png?fit=max\u0026auto=format\u0026n=b7AIIk7hcK-Pou2a\u0026q=85\u0026s=d2f027b73d5e28ee59c8bfb9bfc135ba"},"favicon":"https://mintcdn.com/gravityplay/b7AIIk7hcK-Pou2a/favicon.png?fit=max\u0026auto=format\u0026n=b7AIIk7hcK-Pou2a\u0026q=85\u0026s=b8e7801bd811dd295a96da4a49e284a4","api":{"playground":{"proxy":true}},"appearance":{"default":"system"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gravityplay","hasAudioNarration":false,"actualSubdomain":"gravityplay","customDomains":["docs.gravitypay.app"],"gitSource":{"type":"github","owner":"leonammoura","repo":"gravity-pay","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"4ee58d31-b89d-4b0b-bad3-430ae590cd5f","liveDeploymentHistoryId":"6ada1e628b3d16364f988a2b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada1e628b3d16364f988a2b"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ada1e628b3d16364f988a2b","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":13},{"language":"default","tag":"Guias","count":12},{"language":"default","tag":"Cobranças","count":4},{"language":"default","tag":"Alunos","count":3},{"language":"default","tag":"Introdução","count":2},{"language":"default","tag":"Cursos","count":2},{"language":"default","tag":"Pagamentos","count":2},{"language":"default","tag":"Assinaturas","count":1},{"language":"default","tag":"Turmas","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/cobranças/consultar-cobrança","slug":"/api-reference/cobranças/consultar-cobrança","pageMetadata":{"title":"Consultar cobrança","description":"Retorna uma cobrança pelo id. O `postbackSecret` **não** é retornado aqui — só na criação.\n\nEscopo exigido: `charges:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/charges/{id}","href":"/api-reference/cobranças/consultar-cobrança","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Retorna uma cobrança pelo id. O \", _jsx(_components.code, {\n children: \"postbackSecret\"\n }), \" \", _jsx(_components.strong, {\n children: \"não\"\n }), \" é retornado aqui — só na criação.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Escopo exigido: \", _jsx(_components.code, {\n children: \"charges:read\"\n }), \".\"]\n })]\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}=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":"Consultar cobrança","description":"Retorna uma cobrança pelo id. O `postbackSecret` **não** é retornado aqui — só na criação.\n\nEscopo exigido: `charges:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/charges/{id}","href":"/api-reference/cobranças/consultar-cobrança","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Cobranças"],"summary":"Consultar cobrança","operationId":"getCharge","x-required-scope":"charges:read","description":"Retorna uma cobrança pelo id. O `postbackSecret` **não** é retornado aqui — só na criação.\n\nEscopo exigido: `charges:read`.","parameters":["460aba01-2424-493b-b562-d0e97440d3b0"],"responses":{"200":"5696e175-2d89-4737-b3e1-d9a79b8dbbdd","401":"da70da8d-c1d8-4198-a593-086d2c5648a2","403":"d1f87a51-dbb8-4d79-905c-c6546a430cbb","404":"ad531b43-1d21-48d0-acfd-8d371a72274a"},"method":"get","type":"path","servers":["1c1c7f27-0b9d-401e-a017-98e680c1df97","0f1d9766-b463-4e6d-94bd-1bfaad3810bb"],"security":["09abb6d5-3458-4339-bdbb-4391192bb989"],"path":"/v1/charges/{id}","baseUrlOptions":["https://api.sandbox.gravitypay.app","https://api.gravitypay.app"],"title":"Consultar cobrança","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"460aba01-2424-493b-b562-d0e97440d3b0":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"5696e175-2d89-4737-b3e1-d9a79b8dbbdd":{"description":"Cobrança","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"chg_2e59538f...","uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","example":"charge","uniqueKey":"object","typeLabel":"string"},"status":{"type":"string","enum":["pending","paid","failed","refunded","canceled"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"amountInCents":{"type":"integer","uniqueKey":"amountInCents","typeLabel":"integer"},"currency":{"type":"string","uniqueKey":"currency","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","required":["name","quantity","unitAmountInCents"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"integer"},"unitAmountInCents":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].unitAmountInCents","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"customer":{"type":"object","properties":{"email":{"oneOf":[{"type":"string","uniqueKey":"customer.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.email","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"customer.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.name","typeLabel":"string | null"}},"uniqueKey":"customer","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"uniqueKey":"metadata","typeLabel":"object"},"checkoutUrl":{"type":"string","uniqueKey":"checkoutUrl","typeLabel":"string"},"postbackSecret":{"type":"string","description":"Retornado apenas na criação.","uniqueKey":"postbackSecret","typeLabel":"string"},"boletoDueInDays":{"oneOf":[{"type":"integer","description":"Vencimento do boleto desta cobrança, em dias corridos. null = padrão da loja.","uniqueKey":"boletoDueInDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Vencimento do boleto desta cobrança, em dias corridos. null = padrão da loja.","uniqueKey":"boletoDueInDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"boletoDueInDays","typeLabel":"integer | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"chg_2e59538f...","object":"charge","status":"pending","amountInCents":123,"currency":"\u003cstring>","items":[{"name":"\u003cstring>","quantity":2,"unitAmountInCents":1}],"description":"\u003cstring>","customer":{"email":"\u003cstring>","name":"\u003cstring>"},"metadata":{},"checkoutUrl":"\u003cstring>","postbackSecret":"\u003cstring>","boletoDueInDays":123,"createdAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"da70da8d-c1d8-4198-a593-086d2c5648a2":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","description":"`authentication` (401), `insufficient_scope` (403), `forbidden` (403, rota de parceiro chamada por outra loja), `invalid_request` (400), `not_found` (404) e, no pagamento transparente, `payment_declined` (402), `conflict` (409), `unprocessable` (422) e `gateway_error` (502).","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Detalhe do `type` no pagamento transparente: `charge_not_pending`, `payment_in_progress`, `method_unavailable`, `card_input_not_supported`, `payment_declined` ou `gateway_error`.","uniqueKey":"error.code","typeLabel":"string"},"param":{"type":"string","description":"Parâmetro que falhou, em `invalid_request`.","uniqueKey":"error.param","typeLabel":"string"},"requiredScope":{"type":"string","description":"Escopo que falta, em `insufficient_scope`.","uniqueKey":"error.requiredScope","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>","requiredScope":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d1f87a51-dbb8-4d79-905c-c6546a430cbb":{"description":"A chave é válida, mas não tem o escopo exigido pela operação.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","description":"`authentication` (401), `insufficient_scope` (403), `forbidden` (403, rota de parceiro chamada por outra loja), `invalid_request` (400), `not_found` (404) e, no pagamento transparente, `payment_declined` (402), `conflict` (409), `unprocessable` (422) e `gateway_error` (502).","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Detalhe do `type` no pagamento transparente: `charge_not_pending`, `payment_in_progress`, `method_unavailable`, `card_input_not_supported`, `payment_declined` ou `gateway_error`.","uniqueKey":"error.code","typeLabel":"string"},"param":{"type":"string","description":"Parâmetro que falhou, em `invalid_request`.","uniqueKey":"error.param","typeLabel":"string"},"requiredScope":{"type":"string","description":"Escopo que falta, em `insufficient_scope`.","uniqueKey":"error.requiredScope","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"insufficient_scope","message":"Esta chave de API não tem o escopo students:read.","requiredScope":"students:read"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"insufficient_scope","message":"Esta chave de API não tem o escopo students:read.","requiredScope":"students:read"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ad531b43-1d21-48d0-acfd-8d371a72274a":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","description":"`authentication` (401), `insufficient_scope` (403), `forbidden` (403, rota de parceiro chamada por outra loja), `invalid_request` (400), `not_found` (404) e, no pagamento transparente, `payment_declined` (402), `conflict` (409), `unprocessable` (422) e `gateway_error` (502).","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Detalhe do `type` no pagamento transparente: `charge_not_pending`, `payment_in_progress`, `method_unavailable`, `card_input_not_supported`, `payment_declined` ou `gateway_error`.","uniqueKey":"error.code","typeLabel":"string"},"param":{"type":"string","description":"Parâmetro que falhou, em `invalid_request`.","uniqueKey":"error.param","typeLabel":"string"},"requiredScope":{"type":"string","description":"Escopo que falta, em `insufficient_scope`.","uniqueKey":"error.requiredScope","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>","requiredScope":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"09abb6d5-3458-4339-bdbb-4391192bb989":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"1c1c7f27-0b9d-401e-a017-98e680c1df97":{"url":"https://api.sandbox.gravitypay.app","description":"Sandbox (testes) — alvo do try-it"},"0f1d9766-b463-4e6d-94bd-1bfaad3810bb":{"url":"https://api.gravitypay.app","description":"Produção"}},"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.json"},"subdomain":"gravityplay","siteName":"Gravity Play","title":"Consultar cobrança - Gravity Play","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T14:32:06.439Z","originalFileLocation":"api-reference/cobranças/consultar-cobrança.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=\"Retorna uma cobrança pelo id. O postbackSecret não é retornado aqui — só na criação. Escopo exigido: charges:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gravity Play\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_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/gravityplay/K1lL00SbZCa1K75h/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_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/gravityplay/K1lL00SbZCa1K75h/_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/gravityplay/K1lL00SbZCa1K75h/_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/gravityplay/K1lL00SbZCa1K75h/_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/gravityplay/K1lL00SbZCa1K75h/_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/gravityplay/K1lL00SbZCa1K75h/_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/gravityplay/K1lL00SbZCa1K75h/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Consultar cobrança - Gravity Play\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retorna uma cobrança pelo id. O postbackSecret não é retornado aqui — só na criação. Escopo exigido: charges:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gravity Play\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gravitypay.app/api-reference/cobranças/consultar-cobrança\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gravityplay.mintlify.app/_mintlify/api/og/v2?division=Cobran%C3%A7as\u0026amp;title=Consultar+cobran%C3%A7a\u0026amp;description=Retorna+uma+cobran%C3%A7a+pelo+id.+O+%60postbackSecret%60+**n%C3%A3o**+%C3%A9+retornado+aqui+%E2%80%94+s%C3%B3+na+cria%C3%A7%C3%A3o.%0A%0AEscopo+exigido%3A+%60charges%3Aread%60.\u0026amp;theme=91ba7479a4ba67b966427c49\u0026amp;signature=ddb3dc28465ddc0e267ab7e4cdb2058c39a65f68bf20118e5a263c594ed3d2ef\">\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=\"Consultar cobrança - Gravity Play\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retorna uma cobrança pelo id. O postbackSecret não é retornado aqui — só na criação. Escopo exigido: charges:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gravityplay.mintlify.app/_mintlify/api/og/v2?division=Cobran%C3%A7as\u0026amp;title=Consultar+cobran%C3%A7a\u0026amp;description=Retorna+uma+cobran%C3%A7a+pelo+id.+O+%60postbackSecret%60+**n%C3%A3o**+%C3%A9+retornado+aqui+%E2%80%94+s%C3%B3+na+cria%C3%A7%C3%A3o.%0A%0AEscopo+exigido%3A+%60charges%3Aread%60.\u0026amp;theme=91ba7479a4ba67b966427c49\u0026amp;signature=ddb3dc28465ddc0e267ab7e4cdb2058c39a65f68bf20118e5a263c594ed3d2ef\">\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/gravityplay/K1lL00SbZCa1K75h/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gravity Play\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EA580C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gravitypay.app/api-reference/cobranças/consultar-cobrança\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gravitypay.app/#organization\",\"name\":\"Gravity Play\",\"url\":\"https://docs.gravitypay.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gravityplay/b7AIIk7hcK-Pou2a/logo/light.png?fit=max\u0026auto=format\u0026n=b7AIIk7hcK-Pou2a\u0026q=85\u0026s=098c877fccb72289c5e070695f803600\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gravitypay.app#website\",\"name\":\"Gravity Play\",\"url\":\"https://docs.gravitypay.app\",\"publisher\":{\"@id\":\"https://docs.gravitypay.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a#webpage\",\"url\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a\",\"name\":\"Consultar cobrança\",\"description\":\"Retorna uma cobrança pelo id. O postbackSecret não é retornado aqui — só na criação. Escopo exigido: charges:read.\",\"dateModified\":\"2026-10-22T14:32:06.439Z\",\"isPartOf\":{\"@id\":\"https://docs.gravitypay.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cobranças\",\"item\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/criar-cobran%C3%A7a\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Consultar cobrança\",\"item\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a#apireference\",\"headline\":\"Consultar cobrança\",\"name\":\"Consultar cobrança\",\"description\":\"Retorna uma cobrança pelo id. O postbackSecret não é retornado aqui — só na criação. Escopo exigido: charges:read.\",\"url\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gravitypay.app/api-reference/cobran%C3%A7as/consultar-cobran%C3%A7a#webpage\"},\"dateModified\":\"2026-10-22T14:32:06.439Z\",\"publisher\":{\"@id\":\"https://docs.gravitypay.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gravitypay.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gravity Play\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gravity Play","nav":{"global":null,"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":""}]},{"tab":"Referência da API","groups":[{"group":"Cobranças","pages":[{"title":"Criar cobrança","description":"Cria uma cobrança avulsa e devolve uma `checkoutUrl` para o cliente pagar. O `postbackSecret` (que valida os webhooks desta cobrança) é retornado **apenas** nesta resposta de criação.\n\n**Pagamento transparente:** mande também o campo `payment` (mesmo formato de `POST /v1/charges/{id}/payments`) para criar a cobrança e o pagamento numa chamada só. O corpo inteiro é validado antes: dado faltando, inclusive o que só o gateway da loja exige, é 400 e nenhuma cobrança nasce. Criada a cobrança, a resposta é **sempre 201**, com `payment` quando o pagamento deu certo ou `paymentError` quando falhou (recusa, método indisponível, formato de cartão errado, gateway fora); nesse caso a cobrança segue `pending` e aceita nova tentativa. Replay com o mesmo `Idempotency-Key` devolve a cobrança e o último pagamento dela, sem `postbackSecret` e sem criar outro pagamento.\n\nEscopo exigido: `charges:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/charges","href":"/api-reference/cobranças/criar-cobrança"},{"title":"Consultar cobrança","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/charges/{id}","href":"/api-reference/cobranças/consultar-cobrança"},{"title":"Pagar cobrança (pagamento transparente)","description":"Cria o pagamento de uma cobrança da loja da chave sem tirar o comprador do seu site: PIX (copia-e-cola e QR), boleto (linha digitável e PDF) ou cartão.\n\nO gateway é decidido pela Gravity Play, pela mesma regra do checkout hospedado (veja `GET /v1/payment-methods`); taxa da plataforma, split, parcelamento, e-mails e webhooks são os mesmos. O cartão vai **aberto** só quando o gateway de cartão da loja é Asaas (`card.input = raw`); Pagar.me e Efí recebem `card.token`, gerado no navegador; Stripe só pelo checkout hospedado.\n\nJá existindo um PIX (com mais de 5 minutos de validade) ou boleto (dentro do vencimento) pendente do mesmo método nesta cobrança, ele é devolvido de novo com **200**, sem gerar outro. Duas chamadas simultâneas para a mesma cobrança: uma é atendida e a outra recebe 409 `payment_in_progress`.\n\nO IP do comprador vem de `buyer.ip` (obrigatório no cartão Asaas), nunca do IP da requisição.\n\nEscopo exigido: `charges:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/charges/{id}/payments","href":"/api-reference/cobranças/pagar-cobrança-pagamento-transparente"},{"title":"Métodos de pagamento da loja","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment-methods","href":"/api-reference/cobranças/métodos-de-pagamento-da-loja"}]},{"group":"Pagamentos","pages":[{"title":"Listar cobranças","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payments","href":"/api-reference/pagamentos/listar-cobranças"},{"title":"Listar vendedores","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sales-reps","href":"/api-reference/pagamentos/listar-vendedores"}]},{"group":"Assinaturas","pages":[{"title":"Listar assinaturas","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions","href":"/api-reference/assinaturas/listar-assinaturas"}]},{"group":"Cursos","pages":[{"title":"Listar cursos","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/courses","href":"/api-reference/cursos/listar-cursos"},{"title":"Consultar curso","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/courses/{id}","href":"/api-reference/cursos/consultar-curso"}]},{"group":"Turmas","pages":[{"title":"Listar turmas","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cohorts","href":"/api-reference/turmas/listar-turmas"}]},{"group":"Alunos","pages":[{"title":"Listar alunos","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/students","href":"/api-reference/alunos/listar-alunos"},{"title":"Consultar aluno","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/students/{id}","href":"/api-reference/alunos/consultar-aluno"},{"title":"Progresso do aluno","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/students/{id}/progress","href":"/api-reference/alunos/progresso-do-aluno"}]}]}]},"basePath":"","title":"Consultar cobrança - Gravity Play","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}