{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OriPay API","colors":{"primary":"#0891B2","light":"#22D3EE","dark":"#0E7490"},"favicon":"/images/favicon.png","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","php"]}},"footer":{"socials":{}},"seo":{"metatags":{"og:image":"https://docs.oripaysolutions.com.br/images/og.png","og:image:width":"1200","og:image:height":"630","twitter:image":"https://docs.oripaysolutions.com.br/images/og.png"}},"fonts":{"heading":{"family":"Bricolage Grotesque"}},"integrations":{"telemetry":{"enabled":false}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"hasAudioNarration":false,"customDomains":[],"gitSource":{"type":"github","owner":"local","repo":"local","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"local","isBase":true},"buildId":"local","clientVersion":"0.0.4044"},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true,"isLoggedInCli":false,"mintExport":{}},"customCss":[],"page":{"pagePath":"api-reference/webhooks/consultar-evento","slug":"/api-reference/webhooks/consultar-evento","pageMetadata":{"openapi":"/api-reference/openapi.yaml get /events/{id}","description":"Scope: `webhooks:read`.","href":"/api-reference/webhooks/consultar-evento","title":"Consultar evento"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Scope: \", _jsx(_components.code, {\n children: \"webhooks:read\"\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":{"openapi":"/api-reference/openapi.yaml get /events/{id}","description":"Scope: `webhooks:read`.","href":"/api-reference/webhooks/consultar-evento","title":"Consultar evento"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Webhooks"],"summary":"Consultar evento","operationId":"getEvent","description":"Scope: `webhooks:read`.","parameters":["95308455-d0bc-4798-b37a-51e0ccbf1303"],"responses":{"200":"19cd7e2b-8368-44b3-bea2-4646cb4fdec3","404":"ff444b38-7fa6-4857-8cb6-966602949cf9"},"method":"get","type":"path","servers":["9f7080f5-8536-4fd6-8c72-65772debb1b8"],"security":["8e46bd55-1fcc-4684-9fe9-4b81cba9eb0e"],"path":"/events/{id}","baseUrlOptions":["https://api.oripaysolutions.com.br/v1"],"title":"Consultar evento","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"95308455-d0bc-4798-b37a-51e0ccbf1303":{"name":"id","in":"path","required":true,"description":"ID do evento, com ou sem o prefixo `evt_`.","schema":{"type":"string","example":"evt_9f8e7d6c-5b4a-4321-8fed-cba987654321","isRequired":true,"description":"ID do evento, com ou sem o prefixo `evt_`.","uniqueKey":"","typeLabel":"string"}}},"responses":{"19cd7e2b-8368-44b3-bea2-4646cb4fdec3":{"description":"Evento","content":{"application/json":{"schema":{"type":"object","required":["id","type","created_at","data"],"properties":{"id":{"type":"string","example":"evt_9f8e7d6c-5b4a-4321-8fed-cba987654321","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"type":{"type":"string","enum":["charge.paid","charge.expired","pix.received","transfer.completed","transfer.failed","transfer.returned","refund.completed","refund.failed","webhook.test"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"data":{"oneOf":[{"type":"object","description":"O recurso completo, no formato do GET, como estava quando o evento foi gerado. Em webhook.test, um objeto com message e sent_at","required":["id","external_id","status","amount","qr_code","expires_at","created_at"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"external_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.oneOf.0.external_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.oneOf.0.external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.external_id","typeLabel":"string | null"},"status":{"type":"string","enum":["active","paid","expired"],"isRequired":true,"uniqueKey":"data.oneOf.0.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","isRequired":true,"uniqueKey":"data.oneOf.0.amount","typeLabel":"integer"},"qr_code":{"type":"string","description":"PIX copia e cola","isRequired":true,"uniqueKey":"data.oneOf.0.qr_code","typeLabel":"string"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.description","typeLabel":"string | null"},"qr_code_image":{"oneOf":[{"type":"string","description":"Imagem do QR Code","uniqueKey":"data.oneOf.0.qr_code_image.oneOf.0","typeLabel":"string"},{"type":"null","description":"Imagem do QR Code","uniqueKey":"data.oneOf.0.qr_code_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.qr_code_image","typeLabel":"string | null"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.oneOf.0.paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.oneOf.0.paid_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.paid_at","typeLabel":"string\u003cdate-time> | null"},"received_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.received_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.oneOf.0.received_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.received_id","typeLabel":"string\u003cuuid> | null"},"end_to_end_id":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.end_to_end_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.end_to_end_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.end_to_end_id","typeLabel":"string | null"},"payer":{"oneOf":[{"type":"object","description":"Quem pagou. Preenchido quando a cobrança é paga","properties":{"name":{"oneOf":[{"type":"string","description":"Nome do titular da conta de origem/destino","uniqueKey":"data.oneOf.0.payer.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome do titular da conta de origem/destino","uniqueKey":"data.oneOf.0.payer.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.payer.oneOf.0.name","typeLabel":"string | null"},"document":{"oneOf":[{"type":"string","description":"Mascarado","example":"***.456.789-**","uniqueKey":"data.oneOf.0.payer.oneOf.0.document.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mascarado","example":"***.456.789-**","uniqueKey":"data.oneOf.0.payer.oneOf.0.document.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.payer.oneOf.0.document","typeLabel":"string | null"},"bank":{"oneOf":[{"type":"string","description":"Nome do banco","example":"Banco Exemplo S.A.","uniqueKey":"data.oneOf.0.payer.oneOf.0.bank.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome do banco","example":"Banco Exemplo S.A.","uniqueKey":"data.oneOf.0.payer.oneOf.0.bank.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.payer.oneOf.0.bank","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.0.payer.oneOf.0","typeLabel":"object"},{"type":"null","description":"Quem pagou. Preenchido quando a cobrança é paga","uniqueKey":"data.oneOf.0.payer.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.payer","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.oneOf.0.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"data.oneOf.0.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"data.oneOf.0.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"data.oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.metadata","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"object","description":"O recurso completo, no formato do GET, como estava quando o evento foi gerado. Em webhook.test, um objeto com message e sent_at","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.1.id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","const":"credited","uniqueKey":"data.oneOf.1.status","typeLabel":"string"},"amount":{"type":"integer","description":"Valor bruto creditado. Tarifas são linhas pix_fee no extrato","uniqueKey":"data.oneOf.1.amount","typeLabel":"integer"},"end_to_end_id":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.1.end_to_end_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.1.end_to_end_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.end_to_end_id","typeLabel":"string | null"},"charge_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.oneOf.1.charge_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.oneOf.1.charge_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.charge_id","typeLabel":"string\u003cuuid> | null"},"external_id":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.1.external_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.1.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.external_id","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","uniqueKey":"data.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.metadata","typeLabel":"object | null"},"payer":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Nome do titular da conta de origem/destino","uniqueKey":"data.oneOf.1.payer.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome do titular da conta de origem/destino","uniqueKey":"data.oneOf.1.payer.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.payer.oneOf.0.name","typeLabel":"string | null"},"document":{"oneOf":[{"type":"string","description":"Mascarado","example":"***.456.789-**","uniqueKey":"data.oneOf.1.payer.oneOf.0.document.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mascarado","example":"***.456.789-**","uniqueKey":"data.oneOf.1.payer.oneOf.0.document.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.payer.oneOf.0.document","typeLabel":"string | null"},"bank":{"oneOf":[{"type":"string","description":"Nome do banco","example":"Banco Exemplo S.A.","uniqueKey":"data.oneOf.1.payer.oneOf.0.bank.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome do banco","example":"Banco Exemplo S.A.","uniqueKey":"data.oneOf.1.payer.oneOf.0.bank.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.payer.oneOf.0.bank","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.1.payer.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.oneOf.1.payer.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.payer","typeLabel":"object | null"},"refundable_amount":{"type":"integer","uniqueKey":"data.oneOf.1.refundable_amount","typeLabel":"integer"},"credited_at":{"type":"string","format":"date-time","uniqueKey":"data.oneOf.1.credited_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.oneOf.1","typeLabel":"object"},{"type":"object","description":"O recurso completo, no formato do GET, como estava quando o evento foi gerado. Em webhook.test, um objeto com message e sent_at","required":["id","external_id","status","amount","pix_key_masked","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.2.id","typeLabel":"string\u003cuuid>"},"external_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.oneOf.2.external_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.oneOf.2.external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.2.external_id","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","completed","failed","returned"],"isRequired":true,"uniqueKey":"data.oneOf.2.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","isRequired":true,"uniqueKey":"data.oneOf.2.amount","typeLabel":"integer"},"pix_key_masked":{"oneOf":[{"type":"string","description":"Chave de destino mascarada","isRequired":true,"uniqueKey":"data.oneOf.2.pix_key_masked.oneOf.0","typeLabel":"string"},{"type":"null","description":"Chave de destino mascarada","isRequired":true,"uniqueKey":"data.oneOf.2.pix_key_masked.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.2.pix_key_masked","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.oneOf.2.updated_at","typeLabel":"string\u003cdate-time>"},"recipient":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Nome do titular da conta de origem/destino","uniqueKey":"data.oneOf.2.recipient.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome do titular da conta de origem/destino","uniqueKey":"data.oneOf.2.recipient.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.recipient.oneOf.0.name","typeLabel":"string | null"},"document":{"oneOf":[{"type":"string","description":"Mascarado","example":"***.456.789-**","uniqueKey":"data.oneOf.2.recipient.oneOf.0.document.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mascarado","example":"***.456.789-**","uniqueKey":"data.oneOf.2.recipient.oneOf.0.document.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.recipient.oneOf.0.document","typeLabel":"string | null"},"bank":{"oneOf":[{"type":"string","description":"Nome do banco","example":"Banco Exemplo S.A.","uniqueKey":"data.oneOf.2.recipient.oneOf.0.bank.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome do banco","example":"Banco Exemplo S.A.","uniqueKey":"data.oneOf.2.recipient.oneOf.0.bank.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.recipient.oneOf.0.bank","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.2.recipient.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.oneOf.2.recipient.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.recipient","typeLabel":"object | null"},"end_to_end_id":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.2.end_to_end_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.2.end_to_end_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.end_to_end_id","typeLabel":"string | null"},"failure_reason":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.2.failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.2.failure_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.failure_reason","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.oneOf.2.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"data.oneOf.2.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"data.oneOf.2.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"data.oneOf.2.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.metadata","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"data.oneOf.2","typeLabel":"object"},{"type":"object","description":"O recurso completo, no formato do GET, como estava quando o evento foi gerado. Em webhook.test, um objeto com message e sent_at","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.3.id","typeLabel":"string\u003cuuid>"},"external_id":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.3.external_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.3.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.external_id","typeLabel":"string | null"},"received_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.oneOf.3.received_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.oneOf.3.received_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.received_id","typeLabel":"string\u003cuuid> | null"},"status":{"type":"string","enum":["pending","completed","failed"],"uniqueKey":"data.oneOf.3.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","uniqueKey":"data.oneOf.3.amount","typeLabel":"integer"},"end_to_end_id":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.3.end_to_end_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.3.end_to_end_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.end_to_end_id","typeLabel":"string | null"},"failure_reason":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.3.failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.3.failure_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.failure_reason","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.oneOf.3.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"data.oneOf.3.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.oneOf.3","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"delivery_status":{"type":"string","enum":["pending","delivered","failed"],"uniqueKey":"delivery_status","typeLabel":"enum\u003cstring>"},"attempts":{"type":"integer","description":"Tentativas de entrega feitas","uniqueKey":"attempts","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"evt_9f8e7d6c-5b4a-4321-8fed-cba987654321","type":"charge.paid","created_at":"2023-11-07T05:31:56Z","data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","external_id":"\u003cstring>","status":"active","amount":123,"qr_code":"\u003cstring>","expires_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","qr_code_image":"\u003cstring>","paid_at":"2023-11-07T05:31:56Z","received_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","end_to_end_id":"\u003cstring>","payer":{"name":"\u003cstring>","document":"***.456.789-**","bank":"Banco Exemplo S.A."},"metadata":{}},"delivery_status":"pending","attempts":123}}},"exampleType":"generated"}},"exampleType":"generated"},"ff444b38-7fa6-4857-8cb6-966602949cf9":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","example":"insufficient_balance","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"existing_id":{"oneOf":[{"type":"string","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.existing_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"insufficient_balance","message":"\u003cstring>","request_id":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}],"existing_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8e46bd55-1fcc-4684-9fe9-4b81cba9eb0e":{"apiKey":{"type":"http","scheme":"bearer","description":"Chave `oripay_live_...`. Só funciona dos IPs cadastrados para ela.","scopes":[],"schemeName":"apiKey"}}},"servers":{"9f7080f5-8536-4fd6-8c72-65772debb1b8":{"url":"https://api.oripaysolutions.com.br/v1","description":"Produção (chave oripay_live_). Sandbox em breve."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Chave `oripay_live_...`. Só funciona dos IPs cadastrados para ela.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Chave `oripay_live_...`. Só funciona dos IPs cadastrados para ela.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"localhost","siteName":"OriPay API","title":"Consultar evento - OriPay API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/webhooks/consultar-evento.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=\"Scope: webhooks:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OriPay API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/favicons/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/favicons/favicon-32x32.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/favicons/favicon-16x16.png\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/favicons/favicon.ico\">\u003cmeta data-mint-head property=\"og:title\" content=\"Consultar evento - OriPay API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Scope: webhooks:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OriPay API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.oripaysolutions.com.br/api-reference/webhooks/consultar-evento\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.oripaysolutions.com.br/images/og.png\">\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 evento - OriPay API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Scope: webhooks:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.oripaysolutions.com.br/images/og.png\">\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=\"/favicons/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OriPay API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0891B2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.oripaysolutions.com.br/api-reference/webhooks/consultar-evento\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/consultar-evento.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OriPay API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OriPay API","nav":{"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":""}]},{"tab":"Referência da API","groups":[{"group":"Endpoints","pages":[{"group":"Saldo e extrato","pages":[{"title":"Consultar saldo","openapi":"/api-reference/openapi.yaml get /balance","href":"/api-reference/saldo-e-extrato/consultar-saldo"},{"title":"Consultar limites PIX","openapi":"/api-reference/openapi.yaml get /limits","href":"/api-reference/saldo-e-extrato/consultar-limites-pix"},{"title":"Listar extrato","openapi":"/api-reference/openapi.yaml get /statement","href":"/api-reference/saldo-e-extrato/listar-extrato"}]},{"group":"Cobranças","pages":[{"title":"Listar cobranças","openapi":"/api-reference/openapi.yaml get /pix/charges","href":"/api-reference/cobranças/listar-cobranças"},{"title":"Criar cobrança (QR dinâmico)","openapi":"/api-reference/openapi.yaml post /pix/charges","href":"/api-reference/cobranças/criar-cobrança-qr-dinâmico"},{"title":"Consultar cobrança","openapi":"/api-reference/openapi.yaml get /pix/charges/{id}","href":"/api-reference/cobranças/consultar-cobrança"}]},{"group":"PIX recebidos","pages":[{"title":"Listar PIX recebidos","openapi":"/api-reference/openapi.yaml get /pix/received","href":"/api-reference/pix-recebidos/listar-pix-recebidos"},{"title":"Consultar PIX recebido","openapi":"/api-reference/openapi.yaml get /pix/received/{id}","href":"/api-reference/pix-recebidos/consultar-pix-recebido"}]},{"group":"Devoluções","pages":[{"title":"Devolver PIX recebido","openapi":"/api-reference/openapi.yaml post /pix/received/{id}/refunds","href":"/api-reference/devoluções/devolver-pix-recebido"}]},{"group":"Transferências","pages":[{"title":"Listar transferências","openapi":"/api-reference/openapi.yaml get /pix/transfers","href":"/api-reference/transferências/listar-transferências"},{"title":"Enviar PIX","openapi":"/api-reference/openapi.yaml post /pix/transfers","href":"/api-reference/transferências/enviar-pix"},{"title":"Consultar transferência","openapi":"/api-reference/openapi.yaml get /pix/transfers/{id}","href":"/api-reference/transferências/consultar-transferência"}]},{"group":"Webhooks","pages":[{"title":"Consultar webhook","openapi":"/api-reference/openapi.yaml get /webhook-endpoint","href":"/api-reference/webhooks/consultar-webhook"},{"title":"Enviar evento de teste","openapi":"/api-reference/openapi.yaml post /webhook-endpoint/test","href":"/api-reference/webhooks/enviar-evento-de-teste"},{"title":"Consultar IPs liberados da chave","openapi":"/api-reference/openapi.yaml get /ip-allowlist","href":"/api-reference/webhooks/consultar-ips-liberados-da-chave"},{"title":"Listar eventos (últimos 30 dias)","description":"Scope: `webhooks:read`.","openapi":"/api-reference/openapi.yaml get /events","href":"/api-reference/webhooks/listar-eventos-últimos-30-dias"},{"title":"Consultar evento","openapi":"/api-reference/openapi.yaml get /events/{id}","href":"/api-reference/webhooks/consultar-evento"},{"title":"Listar tentativas de entrega","description":"Scope: `webhooks:read`.","openapi":"/api-reference/openapi.yaml get /events/{id}/deliveries","href":"/api-reference/webhooks/listar-tentativas-de-entrega"},{"title":"Reenviar evento","openapi":"/api-reference/openapi.yaml post /events/{id}/resend","href":"/api-reference/webhooks/reenviar-evento"}]},{"group":"API Reference","pages":[{"title":"Evento enviado ao seu endpoint","openapi":"/api-reference/openapi.yaml webhook event","href":"/api-reference/evento-enviado-ao-seu-endpoint"}]}]}]}]},"basePath":"","title":"Consultar evento - OriPay API","buildId":"b48c568d22cf","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D7wo336Y.js","utils-Dm9zyzuk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DyQG-9DG.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Cb7Xp6KS.js","snippetPresets-D1jos7Rh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BoPLBqmY.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BAJtKqGy.js","shallow-Dq5-SwG1.js","getApiPlaygroundDisplay-wDIhhqfD.js","CodeSnippet-BxA48oHQ.js","CodeSnippets-DuYLY3sy.js","Page-CPu2vF-C.js","getPastedJson-D7mVG7tB.js","icon-HMNWawTa.js","MethodPill-DvQvTgHx.js","DuplicateIcon-DK5o2DOi.js","createIcon-BhUMOhLi.js","DynamicMarkdown-CSW5mrBH.js","SectionHeading-ht66QKGt.js","axios-vUo_bRtp.js","Markdown-CNAGgX2X.js","clsx-DfU2JnNK.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-uP80LYvr.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-R-TmXqAj.js"]}