Skip to main content
A API da Chargefy permite integrar pagamentos, checkout, catálogo, clientes e operações de plataforma diretamente na sua aplicação.

​
URL base

https://api.chargefy.io
Todas as requisições devem usar HTTPS. Requisições HTTP serão rejeitadas.

​
Autenticação

A API é autenticada via API key enviada no header Authorization:
cURL
curl -X GET https://api.chargefy.io/v1/products \
  -H "Authorization: Bearer {{API_KEY}}"
Consulte Authentication para detalhes.

​
Endpoints principais

RecursoEndpointsDescrição
Checkout SessionsGET/POST /v1/checkout-sessionsSessões hospedadas de compra
Payment IntentsGET/POST /v1/payment-intentsCiclo de vida de cobranças
ChargesGET /v1/chargesCobranças originadas por intents e checkout
InvoicesGET /v1/invoices + açõesCobranças documentadas com line items e tentativas de pagamento
Payment MethodsGET/POST /v1/payment-methods + açõesMétodos de pagamento salvos
Setup IntentsGET/POST /v1/setup-intents + açõesPreparação de métodos de pagamento
Payment LinksGET/POST/DELETE /v1/payment-linksLinks de pagamento compartilháveis
CustomersGET/POST/DELETE /v1/customersGestão de clientes
Customer Portal SessionsPOST /v1/customer-portal-sessionsPortal hospedado para clientes
ProductsGET/POST/DELETE /v1/productsProdutos do catálogo
PricesGET/POST/DELETE /v1/pricesPreços associados a produtos
FilesGET/POST/DELETE /v1/filesUpload e gestão de arquivos
OrganizationsGET/POST /v1/organizationsConfiguração da organização
Onboarding SessionsGET/POST /v1/onboarding-sessionsOnboarding hospedado de organizações conectadas

​
Modelo de pagamentos

Use Ciclo de pagamento como referência para escolher o objeto certo:
  • checkout.session orquestra a experiência de compra hospedada.
  • payment_intent representa o estado canônico da cobrança.
  • invoice representa o documento de cobrança ou comprovante, quando o fluxo exige invoice.
  • payment_method representa o instrumento usado para pagar.
A integração não deve depender de IDs internos de processamento como objeto de sucesso. Para fulfillment e reconciliação, use o recurso público retornado pela API e os webhooks correspondentes.

​
Paginação

Endpoints de listagem retornam o envelope canônico de lista e usam cursor. Use starting_after, ending_before e limit para navegar: 
GET /v1/products?limit=20&starting_after=prod_123

​
Resposta de lista

{
  "object": "list",
  "data": [
    {
      "id": "prod_456",
      "object": "product",
      "created_at": "2026-05-16T14:09:27Z",
      "default_price": "price_123",
      "description": null,
      "image_url": null,
      "is_active": true,
      "is_tax_applicable": true,
      "livemode": true,
      "metadata": {},
      "name": "Plano Pro",
      "prices": [
        {
          "id": "price_123",
          "object": "price",
          "created_at": "2026-05-16T14:09:27Z",
          "currency": "brl",
          "is_active": true,
          "livemode": true,
          "metadata": {},
          "name": "Mensal",
          "product": "prod_456",
          "recurring": {
            "interval": "month",
            "interval_count": 1,
            "trial_period_days": null,
            "usage_type": "licensed"
          },
          "tax_behavior": "unspecified",
          "type": "recurring",
          "unit_amount": 9900,
          "updated_at": "2026-05-16T14:09:27Z"
        }
      ],
      "updated_at": "2026-05-16T14:09:27Z"
    }
  ],
  "has_more": true,
  "url": "/v1/products"
}
ParâmetroTipoPadrãoDescrição
starting_afterstring—Cursor para buscar itens depois de um objeto
ending_beforestring—Cursor para buscar itens antes de um objeto
limitinteger10Itens por página

​
Ordenação e filtros

Filtros são específicos por recurso e documentados na página de cada endpoint. Não assuma operadores globais para todos os recursos. 
# Filtro documentado no endpoint de Payment Intents
GET /v1/payment-intents?status=succeeded
Quando um endpoint suporta filtros de intervalo ou igualdade, a página do endpoint lista os parâmetros aceitos.

​
Formato de erros

Endpoints públicos retornam erros no formato canônico: 
{
  "error": {
    "code": "parameter_missing",
    "doc_url": "https://docs.chargefy.io/errors/parameter-missing",
    "message": "Missing required param: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}
type é um destes valores: invalid_request_error, api_error, authentication_error, rate_limit_error, card_error. message é em inglês por padrão. param e doc_url aparecem apenas quando aplicáveis.

​
Códigos de status

CódigoDescrição
200Sucesso. Create, update e actions retornam o objeto público completo
400Requisição inválida (parâmetros faltando ou incorretos)
401Não autenticado (token ausente ou inválido)
403Sem permissão (escopo insuficiente)
404Recurso não encontrado
409Conflito de estado do recurso
422Erro de validação
429Rate limit excedido
500Erro interno do servidor

​
Próximos passos

Authentication

Configurar tokens de acesso

Api Keys

Gerenciar chaves no dashboard

Webhooks

Consultar eventos emitidos