Obter uma requisição

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

{
  "id": "req_yxZKnkX9by8XfYo2",
  "object": "request",
  "actor": {
    "id": "req_RBbUwLR32DgBXgjs",
    "type": "api_key"
  },
  "api_key": "key_QjLpcR3pwYHD",
  "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_yxZKnkX9by8XfYo2",
    "type": "invalid_request_error"
  },
  "ip_address": "203.0.113.10",
  "livemode": true,
  "metadata": {},
  "method": "POST",
  "organization": "org_wBXPgi5ibfQUNEjH",
  "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_yxZKnkX9by8XfYo2",
  "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_yxZKnkX9by8XfYo2",
      "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"
}

{
  "error": {
    "code": "resource_missing",
    "message": "No such request",
    "param": "id",
    "request_log_url": "https://dashboard.chargefy.io/request-logs/req_HUmZfFFyRV7uj6AK",
    "type": "invalid_request_error"
  }
}

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

Consulta uma chamada registrada pelo ID req_*. Este endpoint é útil para investigar exatamente o que foi enviado, qual código HTTP voltou e qual erro a API retornou.

string

required

ID do request (req_*). Você encontra esse valor em GET /v1/requests.

Consultar um request da sua organização

Com uma API key da própria organização, envie apenas a autenticação. Não envie o header Organization.

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

O que olhar ao investigar um erro

Campo	O que mostra
`status`	`failed` quando a chamada terminou com erro.
`status_code`	Código HTTP devolvido, como `400`, `404` ou `500`.
`error`	Erro normalizado, com `code`, `message`, `param` e `type`.
`response_body`	Corpo que a API devolveu ao cliente.
`request_body`	Corpo enviado na chamada.
`request_headers` e `response_headers`	Headers registrados, com valores sensíveis ocultados.
`request_log_url`	Link para abrir a mesma chamada no Dashboard.

A listagem já retorna objetos request completos. Este GET individual é opcional: use-o quando você guardou apenas o ID, quer atualizar o estado de uma chamada ou prefere investigar um request por vez.

Chargefy for Platforms: request 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.

Envie a API key da plataforma e repita o mesmo header Organization usado na listagem. O ID no header deve ser o da organização filha que recebeu a chamada.

curl -X GET "https://api.chargefy.io/v1/requests/req_yxZKnkX9by8XfYo2" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Organization: org_WrhPQawbTs3R9ANi"

Se o request não tiver sido feito pela plataforma autenticada para a organização indicada, a API responde 404.

Resposta

O exemplo abaixo mostra uma chamada que falhou. Compare request_body com error e response_body para descobrir o motivo.

{
  "id": "req_yxZKnkX9by8XfYo2",
  "object": "request",
  "actor": {
    "id": "req_RBbUwLR32DgBXgjs",
    "type": "api_key"
  },
  "api_key": "key_QjLpcR3pwYHD",
  "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_yxZKnkX9by8XfYo2",
    "type": "invalid_request_error"
  },
  "ip_address": "203.0.113.10",
  "livemode": true,
  "metadata": {},
  "method": "POST",
  "organization": "org_wBXPgi5ibfQUNEjH",
  "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_yxZKnkX9by8XfYo2",
  "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_yxZKnkX9by8XfYo2",
      "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"
}

{
  "error": {
    "code": "resource_missing",
    "message": "No such request",
    "param": "id",
    "request_log_url": "https://dashboard.chargefy.io/request-logs/req_HUmZfFFyRV7uj6AK",
    "type": "invalid_request_error"
  }
}

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

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

{
  "id": "req_yxZKnkX9by8XfYo2",
  "object": "request",
  "actor": {
    "id": "req_RBbUwLR32DgBXgjs",
    "type": "api_key"
  },
  "api_key": "key_QjLpcR3pwYHD",
  "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_yxZKnkX9by8XfYo2",
    "type": "invalid_request_error"
  },
  "ip_address": "203.0.113.10",
  "livemode": true,
  "metadata": {},
  "method": "POST",
  "organization": "org_wBXPgi5ibfQUNEjH",
  "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_yxZKnkX9by8XfYo2",
  "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_yxZKnkX9by8XfYo2",
      "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"
}

{
  "error": {
    "code": "resource_missing",
    "message": "No such request",
    "param": "id",
    "request_log_url": "https://dashboard.chargefy.io/request-logs/req_HUmZfFFyRV7uj6AK",
    "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

Obter uma requisição

Consultar um request da sua organização

O que olhar ao investigar um erro

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

Resposta

​Consultar um request da sua organização

​O que olhar ao investigar um erro

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

​Resposta

Consultar um request da sua organização

O que olhar ao investigar um erro

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

Resposta