--- updatedAt: 2026-06-08T19:57:10.000Z agentTools: projectIndex: https://docs.transfeera.dev/llms.txt --- # Consultar eventos # OpenAPI definition ```json { "openapi": "3.1.0", "x-stoplight": { "id": "nsmxy3bpg5k88" }, "info": { "version": "1.0.0", "title": "Webhooks", "contact": { "email": "suporte@transfeera.com", "name": "Suporte" } }, "servers": [ { "url": "https://api.transfeera.com", "description": "Pagamentos Produção" }, { "url": "https://api-sandbox.transfeera.com", "description": "Pagamentos Sandbox" }, { "url": "https://contacerta-api.transfeera.com", "description": "Conta Certa Produção" }, { "url": "https://contacerta-api-sandbox.transfeera.com", "description": "Conta Certa Sandbox" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "go", "node", "javascript", "php", "python", "ruby", "kotlin", "java" ] }, "paths": { "/webhook/event": { "get": { "tags": [ "Webhook" ], "summary": "Consultar eventos", "parameters": [ { "name": "User-Agent", "in": "header", "description": "Todas as requests para a API da Transfeera deve conter o Header \"User-Agent\". Use este Header para nos dizer qual o nome da sua empresa e um e-mail para contato", "schema": { "type": "string", "examples": [ "Empresa X (contato@empresax.com)" ] }, "examples": { "default": { "value": "Empresa X (contato@empresax.com)" } } }, { "name": "initialDate", "in": "query", "description": "Data inicial para filtrar os eventos, no formato YYYY-MM-DDTHH:mm:ssZ", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Data final para filtrar os eventos, no formato YYYY-MM-DDTHH:mm:ssZ", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "description": "Paginação", "required": true, "schema": { "type": "string" } }, { "name": "delivered", "in": "query", "description": "Filtrar por status de entrega do evento", "schema": { "type": "string" } }, { "name": "objectType", "in": "query", "description": "Filtrar por tipos de evento.", "schema": { "type": "string", "enum": [ "Transfer", "TransferRefund", "Account", "Infraction", "PixKey", "Payin", "PayinCardReceivable", "CashIn", "CashInRefund", "ChargeReceivable", "PaymentLink" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string" }, "payload": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "integration_id": { "type": "string" }, "status_description": { "type": "string" }, "txid": { "type": "string" }, "payer": { "type": "object", "properties": { "bank": { "type": "object", "properties": { "code": { "type": "string" }, "ispb": { "type": "string" }, "name": { "type": "string" } } }, "name": { "type": "string" }, "agency": { "type": "string" }, "account": { "type": "string" }, "document": { "type": "string" }, "account_type": { "type": "string" }, "account_digit": { "type": "string" } } }, "value": { "type": "number" }, "pix_key": { "type": "string" }, "end2end_id": { "type": "string" }, "receipt_file_url": { "type": "string" }, "original_end2end_id": { "type": "string" }, "return_id": { "type": "string" }, "receiver": { "type": "object", "properties": { "name": { "type": "string" }, "document": { "type": "string" }, "account_type": { "type": "string" }, "account": { "type": "string" }, "account_digit": { "type": "string" }, "agency": { "type": "string" }, "bank": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "ispb": { "type": "string" } } } } } } }, "date": { "type": "string" }, "object": { "type": "string" }, "version": { "type": "string" } } }, "delivered": { "type": "boolean" }, "requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "request_date": { "type": "string" }, "response_date": { "type": "string" }, "response_code": { "type": "integer" }, "response_payload": { "type": "string" } } } } } } }, "metadata": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "itemsPerPage": { "type": "integer" }, "totalItems": { "type": "integer" } } } } } }, "x-examples": { "Example 1": { "data": [ { "id": "b97da1b3-60cf-4f4a-ad3b-d688dc586686", "date": "2021-09-20T12:20:02.000Z", "payload": { "id": "39521188-4d3b-48b3-b22b-868fa8b9a73e", "account_id": "d95e7630-1b3c-4ac5-991d-d599d75efdd0", "data": { "id": "12345", "status": "FINALIZADO", "integration_id": null, "status_description": null }, "date": "2021-09-20T09:20:02-03:00", "object": "Transfer", "version": "v1" }, "delivered": true, "requests": [ { "id": "35e7de07-3641-4c44-af19-257d9c282c3b", "url": "https://someurl.com", "request_date": "2021-09-20T12:20:04.000Z", "response_date": "2021-09-20T12:20:06.000Z", "response_code": 200, "response_payload": "" } ] }, { "id": "fd2241dc-bd12-447f-856c-56493e7a330d", "date": "2021-09-20T12:15:00.000Z", "payload": { "id": "64f87613-ea38-453a-bbee-07b894b0f083", "account_id": "d95e7630-1b3c-4ac5-991d-d599d75efdd0", "data": { "id": "64f87613-ea38-453a-bbee-07b894b0f083", "txid": "d0209d938a035a92fdaaed191f7245bc", "payer": { "bank": { "code": "260", "ispb": "18236120", "name": "Nu Pagamentos S.A." }, "name": "Fulano da Silva", "agency": "1", "account": "123456", "document": "***.274.581-**", "account_type": "CONTA_POUPANCA", "account_digit": "7" }, "value": 10, "pix_key": "df54cb1f-8cbf-4578-b2b5-8f11b6233d6b", "end2end_id": "E18236120202109201214s125asdfZA", "integration_id": "111111asd11111", "receipt_file_url": "https://api.transfeera.com/pub/receipt/" }, "date": "2021-09-20T09:15:00-03:00", "object": "CashIn", "version": "v1" }, "delivered": false, "requests": [ { "id": "1a907d79-bd02-4672-b7ed-65c1a62d18d3", "url": "https://someurl.com", "request_date": "2021-09-20T12:15:01.000Z", "response_date": "2021-09-20T12:15:09.000Z", "response_code": 200, "response_payload": "" } ] }, { "id": "9053a01a-f2d6-4cce-a6e8-68d71f0832d7", "date": "2021-09-20T12:15:00.000Z", "payload": { "id": "22dd94a8-ee6a-420f-a89f-e3b7db0acb27", "account_id": "d95e7630-1b3c-4ac5-991d-d599d75efdd0", "version": "v1", "object": "CashInRefund", "date": "2019-10-01T17:54:39.000Z", "data": { "id": "22dd94a8-ee6a-420f-a89f-e3b7db0acb27", "status": "DEVOLVIDO", "value": 50.54, "original_end2end_id": "E12345asdf123", "return_id": "R12345asdf123", "integration_id": "abc123", "receiver": { "name": "Fulano da Silva", "document": "***.123.123-**", "account_type": "CONTA_CORRENTE", "account": "12345", "account_digit": "9", "agency": "4321", "bank": { "name": "Banco do Brasil", "code": "001", "ispb": "00000000" } } } }, "delivered": true, "requests": [ { "id": "8fed7a3a-2286-403b-b46c-a0b8d430d3ff", "url": "https://someurl.com", "request_date": "2021-09-20T12:15:01.000Z", "response_date": "2021-09-20T12:15:09.000Z", "response_code": 200, "response_payload": "" } ] } ], "metadata": { "pagination": { "itemsPerPage": 100, "totalItems": 3 } } } } }, "examples": { "Success": { "value": { "data": [ { "id": "b97da1b3-60cf-4f4a-ad3b-d688dc586686", "date": "2021-09-20T12:20:02.000Z", "payload": { "id": "39521188-4d3b-48b3-b22b-868fa8b9a73e", "account_id": "d95e7630-1b3c-4ac5-991d-d599d75efdd0", "data": { "id": "12345", "status": "FINALIZADO", "integration_id": null, "status_description": null }, "date": "2021-09-20T09:20:02-03:00", "object": "Transfer", "version": "v1" }, "delivered": true, "requests": [ { "id": "35e7de07-3641-4c44-af19-257d9c282c3b", "url": "https://someurl.com", "request_date": "2021-09-20T12:20:04.000Z", "response_date": "2021-09-20T12:20:06.000Z", "response_code": 200, "response_payload": "" } ] }, { "id": "fd2241dc-bd12-447f-856c-56493e7a330d", "date": "2021-09-20T12:15:00.000Z", "payload": { "id": "64f87613-ea38-453a-bbee-07b894b0f083", "account_id": "d95e7630-1b3c-4ac5-991d-d599d75efdd0", "data": { "id": "64f87613-ea38-453a-bbee-07b894b0f083", "txid": "d0209d938a035a92fdaaed191f7245bc", "payer": { "bank": { "code": "260", "ispb": "18236120", "name": "Nu Pagamentos S.A." }, "name": "Fulano da Silva", "agency": "1", "account": "123456", "document": "***.274.581-**", "account_type": "CONTA_POUPANCA", "account_digit": "7" }, "value": 10, "pix_key": "df54cb1f-8cbf-4578-b2b5-8f11b6233d6b", "end2end_id": "E18236120202109201214s125asdfZA", "integration_id": "111111asd11111", "receipt_file_url": "https://api.transfeera.com/pub/receipt/" }, "date": "2021-09-20T09:15:00-03:00", "object": "CashIn", "version": "v1" }, "delivered": false, "requests": [ { "id": "1a907d79-bd02-4672-b7ed-65c1a62d18d3", "url": "https://someurl.com", "request_date": "2021-09-20T12:15:01.000Z", "response_date": "2021-09-20T12:15:09.000Z", "response_code": 200, "response_payload": "" } ] }, { "id": "9053a01a-f2d6-4cce-a6e8-68d71f0832d7", "date": "2021-09-20T12:15:00.000Z", "payload": { "id": "22dd94a8-ee6a-420f-a89f-e3b7db0acb27", "account_id": "d95e7630-1b3c-4ac5-991d-d599d75efdd0", "version": "v1", "object": "CashInRefund", "date": "2019-10-01T17:54:39.000Z", "data": { "id": "22dd94a8-ee6a-420f-a89f-e3b7db0acb27", "status": "DEVOLVIDO", "value": 50.54, "original_end2end_id": "E12345asdf123", "return_id": "R12345asdf123", "integration_id": "abc123", "receiver": { "name": "Fulano da Silva", "document": "***.123.123-**", "account_type": "CONTA_CORRENTE", "account": "12345", "account_digit": "9", "agency": "4321", "bank": { "name": "Banco do Brasil", "code": "001", "ispb": "00000000" } } } }, "delivered": true, "requests": [ { "id": "8fed7a3a-2286-403b-b46c-a0b8d430d3ff", "url": "https://someurl.com", "request_date": "2021-09-20T12:15:01.000Z", "response_date": "2021-09-20T12:15:09.000Z", "response_code": 200, "response_payload": "" } ] } ], "metadata": { "pagination": { "itemsPerPage": 100, "totalItems": 3 } } } } } } } } }, "security": [ { "basic": [] } ], "servers": [ { "url": "https://api.transfeera.com", "description": "Produção" }, { "url": "https://api-sandbox.transfeera.com", "description": "Sandbox" } ], "x-stoplight": { "id": "94x7ivlo49wr3" } } } } } ```