{ "success": true, "message": "Webhook configurado com sucesso"}
Webhooks
Configurar webhook da conta
Requer token Bearer no header Authorization.
Configura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert).
Eventos disponíveis:
cash_in - PIX recebido
cash_out - PIX enviado
refund_in - Estorno de recebimento (devolução solicitada)
refund_out - Devolução recebida
Headers personalizados:
Você pode configurar até 5 headers customizados para autenticação do seu endpoint.
Headers bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent.
Invalidação de cache:
Ao configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Documentação da API Fire Banking","colors":{"primary":"#FF6B35","light":"#FF8C5A","dark":"#E55A2B"},"logo":{"light":"https://res.cloudinary.com/dcjuutigr/image/upload/v1758124358/fire-bg-white_rcfiee.svg","dark":"https://link-pagamento.firebanking.dev/logo-fire/logo-white.svg"},"favicon":"https://framerusercontent.com/images/4hv5Es96tVihvEznIZL17Po7Eg.svg","api":{"playground":{}},"appearance":{"default":"light"},"navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.firebanking.com.br"}},"footer":{},"seo":{},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":true},"navigation":{"global":{"languages":[{"language":"pt-BR","default":true,"href":"https://docs.firebanking.com.br"}],"anchors":[{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.firebanking.com.br"},{"anchor":"Status","icon":"signal","href":"https://status.firebanking.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firebanking-48b680b3","hasAudioNarration":false,"actualSubdomain":"firebanking-48b680b3","customDomains":["docs.firebanking.dev"],"gitSource":{"type":"github","owner":"avistaglobal","repo":"avista-mintlify","deployBranch":"firebanking","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae93f3099595eff9399ca47:success","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Guias","count":18},{"language":"default","tag":"Referência da API","count":13},{"language":"default","tag":"Webhooks","count":11},{"language":"default","tag":"PIX Bacen","count":11},{"language":"default","tag":"Transações PIX","count":8},{"language":"default","tag":"Guias de Integração","count":8},{"language":"default","tag":"Introdução","count":5},{"language":"default","tag":"Endpoints","count":4},{"language":"default","tag":"Webhooks V2","count":4},{"language":"default","tag":"Autenticação","count":1}]},"assistantConfig":{},"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/webhooks-setup","slug":"/api-reference/endpoints/webhooks-setup","pageMetadata":{"openapi":"post /api/webhooks","title":"Configurar webhook da conta","description":"**Requer token Bearer no header Authorization**.\n\nConfigura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert).\n\n**Eventos disponíveis:**\n- `cash_in` - PIX recebido\n- `cash_out` - PIX enviado\n- `refund_in` - Estorno de recebimento (devolução solicitada)\n- `refund_out` - Devolução recebida\n\n**Headers personalizados:**\nVocê pode configurar até 5 headers customizados para autenticação do seu endpoint.\nHeaders bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent.\n\n**Invalidação de cache:**\nAo configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.","href":"/api-reference/endpoints/webhooks-setup","hidden":false},"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 li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Requer token Bearer no header Authorization\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Configura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert).\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Eventos disponíveis:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"cash_in\"\n }), \" - PIX recebido\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"cash_out\"\n }), \" - PIX enviado\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"refund_in\"\n }), \" - Estorno de recebimento (devolução solicitada)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"refund_out\"\n }), \" - Devolução recebida\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Headers personalizados:\"\n }), \"\\nVocê pode configurar até 5 headers customizados para autenticação do seu endpoint.\\nHeaders bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Invalidação de cache:\"\n }), \"\\nAo configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.\"]\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":"post /api/webhooks","title":"Configurar webhook da conta","description":"**Requer token Bearer no header Authorization**.\n\nConfigura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert).\n\n**Eventos disponíveis:**\n- `cash_in` - PIX recebido\n- `cash_out` - PIX enviado\n- `refund_in` - Estorno de recebimento (devolução solicitada)\n- `refund_out` - Devolução recebida\n\n**Headers personalizados:**\nVocê pode configurar até 5 headers customizados para autenticação do seu endpoint.\nHeaders bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent.\n\n**Invalidação de cache:**\nAo configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.","href":"/api-reference/endpoints/webhooks-setup","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Configurar webhook da conta","description":"**Requer token Bearer no header Authorization**.\n\nConfigura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert).\n\n**Eventos disponíveis:**\n- `cash_in` - PIX recebido\n- `cash_out` - PIX enviado\n- `refund_in` - Estorno de recebimento (devolução solicitada)\n- `refund_out` - Devolução recebida\n\n**Headers personalizados:**\nVocê pode configurar até 5 headers customizados para autenticação do seu endpoint.\nHeaders bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent.\n\n**Invalidação de cache:**\nAo configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.","operationId":"WebhooksConfigController_setupWebhook","tags":["Webhooks"],"parameters":[],"security":["7d016d3d-894c-4348-bb0f-6b79cbb6850d"],"requestBody":"6ffde4cb-bf0a-4425-8d11-bc6611059eaa","responses":{"200":"7e6b1255-fcb1-49df-a4b1-e9efd11da1b7","400":"86e05b39-1c38-4c71-989e-7626a87119f3","401":"fef13158-3e9d-4519-89ed-80b1cf065877","404":"13d42cfa-0ab3-4c2d-adab-2ddebc8270e3","500":"88fe3c46-70f2-4c61-8da1-c23694db655f"},"method":"post","type":"path","servers":["4e6f5456-6c30-44ec-962f-eb3a0697baa1"],"path":"/api/webhooks","baseUrlOptions":["https://api.public.firebanking.com.br"],"title":"Configurar webhook da conta","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","eventType"],"properties":{"url":{"type":"string","format":"uri","description":"URL HTTPS do endpoint que receberá os webhooks. Deve usar protocolo HTTPS.","example":"https://api.example.com/webhooks/pix","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"eventType":{"type":"string","description":"Tipo de evento para receber notificações","enum":["cash_in","cash_out","refund_in","refund_out"],"example":"cash_in","isRequired":true,"uniqueKey":"eventType","typeLabel":"enum\u003cstring>"},"headers":{"type":"array","description":"Headers customizados para autenticação (máximo 5). Headers bloqueados: host, content-length, connection, transfer-encoding, content-type, user-agent","maxItems":5,"items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Nome do header customizado","example":"Authorization","isRequired":true,"uniqueKey":"headers.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Valor do header","example":"Bearer token123","isRequired":true,"uniqueKey":"headers.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"headers.items.[INDEX]","typeLabel":"object"},"example":[{"key":"Authorization","value":"Bearer token123"},{"key":"X-Webhook-Secret","value":"abc123"}],"uniqueKey":"headers","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"url":"https://api.example.com/webhooks/pix","eventType":"cash_in","headers":[{"key":"Authorization","value":"Bearer token123"},{"key":"X-Webhook-Secret","value":"abc123"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7e6b1255-fcb1-49df-a4b1-e9efd11da1b7":{"description":"Webhook configurado com sucesso","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","description":"Indica se a operação foi bem-sucedida","example":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Mensagem descritiva do resultado","example":"Webhook configurado com sucesso","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"Webhook configurado com sucesso"}}},"exampleType":"generated"}},"exampleType":"generated"},"86e05b39-1c38-4c71-989e-7626a87119f3":{"description":"Dados inválidos (URL não é HTTPS, tipo de evento inválido, etc.)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"fef13158-3e9d-4519-89ed-80b1cf065877":{"description":"Token não fornecido ou inválido","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"13d42cfa-0ab3-4c2d-adab-2ddebc8270e3":{"description":"Conta não encontrada","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"88fe3c46-70f2-4c61-8da1-c23694db655f":{"description":"Erro interno ao configurar webhook","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"7d016d3d-894c-4348-bb0f-6b79cbb6850d":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter JWT token","scopes":[]}}},"servers":{"4e6f5456-6c30-44ec-962f-eb3a0697baa1":{"url":"https://api.public.firebanking.com.br","description":"Servidor de produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter JWT token","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Enter JWT token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"firebanking-48b680b3","siteName":"Documentação da API Fire Banking","title":"Configurar webhook da conta - Documentação da API Fire Banking","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-09T20:35:08.641Z","originalFileLocation":"api-reference/endpoints/webhooks-setup.mdx","locale":"pt-BR"},"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=\"light\"}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=\"Requer token Bearer no header Authorization. Configura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert). Eventos disponíveis: - cash_in - PIX recebido - cash_out - PIX enviado - refund_in - Estorno de recebimento (devolução solicitada) - refund_out - Devolução recebida Headers personalizados: Você pode configurar até 5 headers customizados para autenticação do seu endpoint. Headers bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent. Invalidação de cache: Ao configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Documentação da API Fire Banking\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/svg+xml\" sizes=\"180x180\" href=\"https://framerusercontent.com/images/4hv5Es96tVihvEznIZL17Po7Eg.svg\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://framerusercontent.com/images/4hv5Es96tVihvEznIZL17Po7Eg.svg\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://framerusercontent.com/images/4hv5Es96tVihvEznIZL17Po7Eg.svg\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://framerusercontent.com/images/4hv5Es96tVihvEznIZL17Po7Eg.svg\">\u003cmeta data-mint-head property=\"og:title\" content=\"Configurar webhook da conta - Documentação da API Fire Banking\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requer token Bearer no header Authorization. Configura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert). Eventos disponíveis: - cash_in - PIX recebido - cash_out - PIX enviado - refund_in - Estorno de recebimento (devolução solicitada) - refund_out - Devolução recebida Headers personalizados: Você pode configurar até 5 headers customizados para autenticação do seu endpoint. Headers bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent. Invalidação de cache: Ao configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Documentação da API Fire Banking\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firebanking-48b680b3.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Configurar+webhook+da+conta\u0026amp;description=**Requer+token+Bearer+no+header+Authorization**.%0A%0AConfigura+ou+atualiza+a+URL+de+webhook+para+um+tipo+de+evento+espec%C3%ADfico.+Se+j%C3%A1+existir+um+webhook+configurado\u0026amp;theme=d5ed22bf7a9a9e43ff77b070\u0026amp;signature=704db98587d3ca67f8b01be58c1977b21e513dc1cc5f51d70a379287a176798e\">\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=\"Configurar webhook da conta - Documentação da API Fire Banking\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requer token Bearer no header Authorization. Configura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert). Eventos disponíveis: - cash_in - PIX recebido - cash_out - PIX enviado - refund_in - Estorno de recebimento (devolução solicitada) - refund_out - Devolução recebida Headers personalizados: Você pode configurar até 5 headers customizados para autenticação do seu endpoint. Headers bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent. Invalidação de cache: Ao configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firebanking-48b680b3.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Configurar+webhook+da+conta\u0026amp;description=**Requer+token+Bearer+no+header+Authorization**.%0A%0AConfigura+ou+atualiza+a+URL+de+webhook+para+um+tipo+de+evento+espec%C3%ADfico.+Se+j%C3%A1+existir+um+webhook+configurado\u0026amp;theme=d5ed22bf7a9a9e43ff77b070\u0026amp;signature=704db98587d3ca67f8b01be58c1977b21e513dc1cc5f51d70a379287a176798e\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/firebanking-48b680b3/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentação da API Fire Banking\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6B35\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/webhooks-setup.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.firebanking.dev/#organization\",\"name\":\"Documentação da API Fire Banking\",\"url\":\"https://docs.firebanking.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://res.cloudinary.com/dcjuutigr/image/upload/v1758124358/fire-bg-white_rcfiee.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.firebanking.dev#website\",\"name\":\"Documentação da API Fire Banking\",\"url\":\"https://docs.firebanking.dev\",\"publisher\":{\"@id\":\"https://docs.firebanking.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup#webpage\",\"url\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup\",\"name\":\"Configurar webhook da conta\",\"description\":\"Requer token Bearer no header Authorization. Configura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert). Eventos disponíveis: - cash_in - PIX recebido - cash_out - PIX enviado - refund_in - Estorno de recebimento (devolução solicitada) - refund_out - Devolução recebida Headers personalizados: Você pode configurar até 5 headers customizados para autenticação do seu endpoint. Headers bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent. Invalidação de cache: Ao configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.\",\"dateModified\":\"2026-02-09T20:35:08.641Z\",\"isPartOf\":{\"@id\":\"https://docs.firebanking.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Configurar webhook da conta\",\"item\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup#apireference\",\"headline\":\"Configurar webhook da conta\",\"name\":\"Configurar webhook da conta\",\"description\":\"Requer token Bearer no header Authorization. Configura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert). Eventos disponíveis: - cash_in - PIX recebido - cash_out - PIX enviado - refund_in - Estorno de recebimento (devolução solicitada) - refund_out - Devolução recebida Headers personalizados: Você pode configurar até 5 headers customizados para autenticação do seu endpoint. Headers bloqueados (não permitidos): host, content-length, connection, transfer-encoding, content-type, user-agent. Invalidação de cache: Ao configurar um webhook, o cache é invalidado automaticamente no serviço de notificações. Transações subsequentes usarão a nova configuração imediatamente.\",\"url\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firebanking.dev/api-reference/endpoints/webhooks-setup#webpage\"},\"dateModified\":\"2026-02-09T20:35:08.641Z\",\"publisher\":{\"@id\":\"https://docs.firebanking.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.firebanking.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentação da API Fire Banking\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentação da API Fire Banking","nav":{"global":{"languages":[{"language":"pt-BR","default":true,"href":"https://docs.firebanking.com.br"}],"anchors":[{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.firebanking.com.br"},{"anchor":"Status","icon":"signal","href":"https://status.firebanking.io"}]},"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/api-reference/introduction"}]},{"tab":"Referência da API","groups":[{"group":"Autenticação","pages":[{"openapi":"post /api/auth/token","title":"Gerar token de acesso JWT","href":"/api-reference/endpoints/generate-token","hidden":false}]},{"group":"Saldo","pages":[{"openapi":"get /api/balance","title":"Consultar saldo da conta","href":"/api-reference/endpoints/get-balance","hidden":false}]},{"group":"Transações PIX","pages":[{"openapi":"post /api/pix/cash-in","title":"Gerar cobrança PIX (Cash-In)","href":"/api-reference/endpoints/pix-cash-in","hidden":false},{"openapi":"post /api/pix/cash-out","title":"Realizar pagamento PIX (Cash-Out)","href":"/api-reference/endpoints/pix-cash-out","hidden":false},{"openapi":"post /api/pix/cash-out-qrcode","title":"Realizar pagamento PIX via QR Code (Cash-Out QR Code)","href":"/api-reference/endpoints/pix-cash-out-qrcode","hidden":false},{"openapi":"post /api/pix/refund-in/{id}","title":"Solicitar estorno de pagamento recebido (Refund-In)","href":"/api-reference/endpoints/pix-refund-in","hidden":false},{"openapi":"get /api/pix/transaction/{id}","title":"Consultar status de transação","href":"/api-reference/endpoints/pix-transaction-poll","hidden":false},{"openapi":"get /api/transactions","title":"Buscar transações da conta","href":"/api-reference/endpoints/transactions-search","hidden":false},{"openapi":"get /api/pix/transactions/pix-key/{pixKey}","title":"Listar transações por chave PIX","href":"/api-reference/endpoints/list-transactions-by-pix-key","hidden":false},{"openapi":"get /api/pix/transactions/pix-key/{pixKey}/{identifier}","title":"Consultar transação por chave PIX e identificador","href":"/api-reference/endpoints/get-transaction-by-pix-key","hidden":false}]},{"group":"Webhooks","pages":[{"openapi":"get /api/webhooks","title":"Listar webhooks da conta","description":"**Requer token Bearer no header Authorization**.\n\nRetorna todos os webhooks configurados para a conta autenticada.\n\nCada webhook inclui:\n- **id**: Identificador único do webhook\n- **type**: Tipo do evento (cash_in, cash_out, refund_in, refund_out)\n- **url**: URL do endpoint configurado\n- **headers**: Headers customizados\n- **isActive**: Status do webhook\n- **createdAt**: Data de criação","href":"/api-reference/endpoints/webhooks-list","hidden":false},{"openapi":"post /api/webhooks","title":"Configurar webhook da conta","href":"/api-reference/endpoints/webhooks-setup","hidden":false},{"openapi":"post /api/resend-webhook/{transactionIdentifier}","title":"Reenviar webhook de transação","description":"**Requer token Bearer no header Authorization**.\n\nReenvia o webhook de uma transação específica para a URL configurada ou para uma URL temporária (override).\n\nO identificador da transação pode ser:\n- **ID numérico da transação**: O ID retornado pela Fire Banking (campo `transactionId` nos webhooks)\n- **Seu ID de referência**: O identificador que você forneceu ao criar a transação (externalId)\n- **End-to-End ID do PIX**: O e2eId retornado nos webhooks (formato: E/D + 32 chars)\n\n**Webhook por Tipo de Operação**:\n- Cada tipo de operação (cash_in, cash_out, refund_in, refund_out) pode ter uma URL de webhook diferente\n- O sistema identifica automaticamente o tipo da transação e busca a URL correspondente\n- Se não houver webhook configurado para o tipo específico, retorna erro 400\n\n**Comportamento de URL**:\n- Se `url` for fornecido no body, usa essa URL temporariamente (não persiste)\n- Se `url` não for fornecido, usa a URL configurada no webhook da conta para o tipo da operação\n- Se nenhuma URL estiver disponível, retorna erro 400\n\n**Rate Limiting**: 60 requisições por minuto por conta.","href":"/api-reference/endpoints/webhook-resend","hidden":false}]}]},{"tab":"PIX Bacen","pages":[{"title":"PIX Bacen","href":"/pix-bacen/introduction"}]}]},"basePath":"","title":"Configurar webhook da conta - Documentação da API Fire Banking","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}