Listar requisições

curl -X GET "https://api.chargefy.io/v1/requests?limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "object": "list",
  "data": [
    {
      "id": "req_1HSbnkWKmZKGqTX8",
      "object": "request",
      "actor": {
        "id": "req_HETLHGa21bCdH5Ct",
        "type": "api_key"
      },
      "api_key": "key_U89iUdyYBLAS",
      "completed_at": "2026-05-27T14:09:28Z",
      "created_at": "2026-05-27T14:09:27Z",
      "duration_ms": 184,
      "error": {
        "code": "invalid_request",
        "message": "amount must be a positive integer",
        "param": "amount",
        "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
        "type": "invalid_request_error"
      },
      "ip_address": "203.0.113.10",
      "livemode": true,
      "metadata": {},
      "method": "POST",
      "organization": "org_7e8JZsn3LUQdbxwB",
      "path": "/v1/payment-intents",
      "query": {},
      "related_objects": [],
      "request_body": {
        "amount": -1,
        "currency": "brl"
      },
      "request_body_type": "json",
      "request_headers": {
        "authorization": "[redacted]",
        "content-type": "application/json"
      },
      "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
      "response_body": {
        "error": {
          "code": "invalid_request",
          "message": "amount must be a positive integer",
          "param": "amount",
          "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
          "type": "invalid_request_error"
        }
      },
      "response_body_type": "json",
      "response_headers": {
        "content-type": "application/json"
      },
      "source": "api",
      "status": "failed",
      "status_code": 400,
      "updated_at": "2026-05-27T14:09:28Z",
      "user_agent": "curl/8.7.1"
    }
  ],
  "has_more": false,
  "url": "/v1/requests"
}

{
  "error": {
    "code": "invalid_request",
    "message": "limit must be between 1 and 100.",
    "param": "limit",
    "request_log_url": "https://dashboard.chargefy.io/request-logs/req_bEMdQcm7ESUusKJq",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Lista as chamadas registradas para a organização, da mais recente para a mais antiga. Use este endpoint para investigar integrações, encontrar falhas e consultar o que foi enviado e retornado em cada chamada. Os itens de data já são objetos request completos. Se quiser consultar uma chamada isoladamente, copie o campo id e use GET /v1/requests/{id}.

Consultar requests da sua organização

Com uma API key da própria organização, basta fazer a chamada abaixo. Não envie o header Organization.

curl -X GET "https://api.chargefy.io/v1/requests?limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

Filtros

Todos os filtros podem ser combinados.

O que você quer encontrar	Query string
Somente chamadas que falharam	`?status=failed`
Somente respostas HTTP 400	`?status_code=400`
Falhas em chamadas `POST`	`?method=POST&status=failed`
Chamadas para um endpoint exato	`?path=/v1/payment-intents`
Chamadas feitas por uma API key	`?api_key=key_U89iUdyYBLAS`
Chamadas a partir de uma data	`?created_at[gte]=2026-07-01T00:00:00Z`

string

Filtra pelo método HTTP, como GET, POST, PATCH ou DELETE.

string

Filtra pelo path exato, como /v1/payment-intents.

string

Filtra pela origem da chamada.

Valor	Descrição
`api`	Chamada direta à API pública.
`hosted`	Superfície hospedada da Chargefy.
`dashboard`	Ação originada no dashboard.
`gateway`	Chamada registrada pelo gateway da API.
`system`	Processo interno da Chargefy.
`mcp`	Chamada feita por um agente através do servidor MCP da Chargefy.

string

Filtra pelo resultado do request.

Valor	Descrição
`pending`	Recebido e ainda em processamento.
`succeeded`	Concluído com resposta de sucesso.
`failed`	Concluído com resposta de erro.

integer

Filtra por um status HTTP exato, como 400, 404 ou 500.

string

Filtra pelo ID público da API key que originou a chamada, no formato key_.... Não envie a credencial secreta ch_live_... ou ch_test_... neste filtro.

string

Filtra requests criados a partir do timestamp ISO 8601 informado, inclusive.

string

Filtra requests criados até o timestamp ISO 8601 informado, inclusive.

integer

default:"10"

Quantidade de itens por página, de 1 a 100.

string

ID do último request da página atual. Use para buscar a próxima página.

string

ID do primeiro request da página atual. Use para buscar a página anterior.

Exemplo: listar somente falhas

curl -X GET "https://api.chargefy.io/v1/requests?method=POST&status=failed&limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

Chargefy for Platforms: requests de uma organização filha

Esta seção se aplica somente a contas com o produto Chargefy for Platforms habilitado. Uma plataforma só pode consultar requests que ela própria fez para suas organizações filhas.

Use a API key da plataforma e informe a organização filha no header Organization. Não use organization_id na query string.

Escolha a organização filha

Obtenha o ID da organização que deseja investigar, como org_7Dk9mQ2vX5rT8pWN.

Liste as requests da organização

Envie o ID no header Organization. O resultado fica restrito às chamadas feitas pela plataforma autenticada para essa organização.

Filtre e investigue

Use status=failed para encontrar falhas. Depois, copie o id de uma chamada e consulte o request individual para ver o erro e a resposta.

Listar todas as requests da organização filha

curl -X GET "https://api.chargefy.io/v1/requests?limit=100" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Organization: org_om8GrigDBL2VD826"

Listar somente as que deram erro

curl -X GET "https://api.chargefy.io/v1/requests?status=failed&limit=100" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Organization: org_om8GrigDBL2VD826"

Para procurar um código específico, troque o filtro por status_code=400. Você também pode combinar os dois filtros.

O header Organization define o escopo da consulta. Mesmo que a organização filha também tenha outras integrações, a API não retorna chamadas feitas por outra plataforma nem chamadas próprias da organização.

Resposta

200 OK retorna uma lista de objetos request completos. O campo organization confirma a organização consultada, e dados sensíveis como tokens e credenciais são substituídos por [redacted].

{
  "object": "list",
  "data": [
    {
      "id": "req_1HSbnkWKmZKGqTX8",
      "object": "request",
      "actor": {
        "id": "req_HETLHGa21bCdH5Ct",
        "type": "api_key"
      },
      "api_key": "key_U89iUdyYBLAS",
      "completed_at": "2026-05-27T14:09:28Z",
      "created_at": "2026-05-27T14:09:27Z",
      "duration_ms": 184,
      "error": {
        "code": "invalid_request",
        "message": "amount must be a positive integer",
        "param": "amount",
        "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
        "type": "invalid_request_error"
      },
      "ip_address": "203.0.113.10",
      "livemode": true,
      "metadata": {},
      "method": "POST",
      "organization": "org_7e8JZsn3LUQdbxwB",
      "path": "/v1/payment-intents",
      "query": {},
      "related_objects": [],
      "request_body": {
        "amount": -1,
        "currency": "brl"
      },
      "request_body_type": "json",
      "request_headers": {
        "authorization": "[redacted]",
        "content-type": "application/json"
      },
      "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
      "response_body": {
        "error": {
          "code": "invalid_request",
          "message": "amount must be a positive integer",
          "param": "amount",
          "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
          "type": "invalid_request_error"
        }
      },
      "response_body_type": "json",
      "response_headers": {
        "content-type": "application/json"
      },
      "source": "api",
      "status": "failed",
      "status_code": 400,
      "updated_at": "2026-05-27T14:09:28Z",
      "user_agent": "curl/8.7.1"
    }
  ],
  "has_more": false,
  "url": "/v1/requests"
}

{
  "error": {
    "code": "invalid_request",
    "message": "limit must be between 1 and 100.",
    "param": "limit",
    "request_log_url": "https://dashboard.chargefy.io/request-logs/req_bEMdQcm7ESUusKJq",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Para uma API key de plataforma, a ausência do header Organization ou o uso de uma organização que não seja filha ativa da plataforma responde 403.

curl -X GET "https://api.chargefy.io/v1/requests?limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "object": "list",
  "data": [
    {
      "id": "req_1HSbnkWKmZKGqTX8",
      "object": "request",
      "actor": {
        "id": "req_HETLHGa21bCdH5Ct",
        "type": "api_key"
      },
      "api_key": "key_U89iUdyYBLAS",
      "completed_at": "2026-05-27T14:09:28Z",
      "created_at": "2026-05-27T14:09:27Z",
      "duration_ms": 184,
      "error": {
        "code": "invalid_request",
        "message": "amount must be a positive integer",
        "param": "amount",
        "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
        "type": "invalid_request_error"
      },
      "ip_address": "203.0.113.10",
      "livemode": true,
      "metadata": {},
      "method": "POST",
      "organization": "org_7e8JZsn3LUQdbxwB",
      "path": "/v1/payment-intents",
      "query": {},
      "related_objects": [],
      "request_body": {
        "amount": -1,
        "currency": "brl"
      },
      "request_body_type": "json",
      "request_headers": {
        "authorization": "[redacted]",
        "content-type": "application/json"
      },
      "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
      "response_body": {
        "error": {
          "code": "invalid_request",
          "message": "amount must be a positive integer",
          "param": "amount",
          "request_log_url": "https://dashboard.chargefy.io/request-logs/req_1HSbnkWKmZKGqTX8",
          "type": "invalid_request_error"
        }
      },
      "response_body_type": "json",
      "response_headers": {
        "content-type": "application/json"
      },
      "source": "api",
      "status": "failed",
      "status_code": 400,
      "updated_at": "2026-05-27T14:09:28Z",
      "user_agent": "curl/8.7.1"
    }
  ],
  "has_more": false,
  "url": "/v1/requests"
}

{
  "error": {
    "code": "invalid_request",
    "message": "limit must be between 1 and 100.",
    "param": "limit",
    "request_log_url": "https://dashboard.chargefy.io/request-logs/req_bEMdQcm7ESUusKJq",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Listar requisições

Consultar requests da sua organização

Filtros

Exemplo: listar somente falhas

Chargefy for Platforms: requests de uma organização filha

Listar todas as requests da organização filha

Listar somente as que deram erro

Resposta

​Consultar requests da sua organização

​Filtros

​Exemplo: listar somente falhas

​Chargefy for Platforms: requests de uma organização filha

​Listar todas as requests da organização filha

​Listar somente as que deram erro

​Resposta

Consultar requests da sua organização

Filtros

Exemplo: listar somente falhas

Chargefy for Platforms: requests de uma organização filha

Listar todas as requests da organização filha

Listar somente as que deram erro

Resposta