Skip to main content
Use este glossário para entender como os recursos da Chargefy se relacionam. Os nomes de objetos da API aparecem em código quando forem diferentes do nome usado no Dashboard.

​
A

​
API

Interface usada pelo seu sistema para criar, consultar e atualizar recursos da Chargefy. As requisições são enviadas para https://api.chargefy.io e autenticadas com uma chave de API.

​
Assinatura

Contrato de cobrança recorrente de um customer. Uma subscription usa preços recorrentes para gerar invoices e tentativas de pagamento ao longo do tempo.

​
Ativação

Processo de validação cadastral e financeira de uma organização. Inclui dados do negócio, identidade do titular ou responsável legal, documentos, conta bancária e aceite dos termos. A organização precisa estar active para confirmar pagamentos. Veja Verificação KYC.

​
Ambiente

Contexto que separa operações de teste e produção. Recursos e chaves de API do modo de teste não são compartilhados com o modo de produção. Veja Ambiente de testes.

​
C

​
Captura

Etapa que conclui a cobrança de um pagamento com cartão previamente autorizado. Quando a captura é manual, a autorização e a captura acontecem em momentos diferentes. Veja Captura assíncrona.

​
Charge

Registro de uma tentativa concreta de cobrança criada durante o processamento de um pagamento. Um Payment Intent pode gerar mais de uma charge ao longo das tentativas. Veja Cobranças.

​
Chave de API

Credencial secreta usada por um servidor para autenticar requisições. Cada chave pertence a um ambiente e possui um escopo de acesso. Nunca exponha uma chave secreta no navegador ou em um aplicativo cliente. Veja Chaves de API.

​
Checkout

Experiência em que o comprador revisa um pedido e informa os dados necessários para pagar. A Chargefy oferece checkout hospedado e componentes para fluxos integrados.

​
Checkout Session

Objeto que reúne itens, customer, formas de pagamento e configurações de uma sessão de checkout. A URL hospedada fica disponível enquanto a sessão estiver aberta. Veja Checkout Sessions.

​
Conta para saques

Destino bancário configurado para receber as liquidações de uma organização. Na API, é representado pelo objeto payout_account (pa_*). A titularidade deve corresponder ao CPF ou CNPJ informado na ativação. Veja Contas para saques.

​
Customer

Registro que representa a pessoa ou empresa atendida pelo seu negócio. Customers podem ter dados de contato, endereço, formas de pagamento salvas, assinaturas e histórico de cobranças. Veja Gerenciamento de customers.

​
D

​
Dashboard

Área administrativa da Chargefy usada para configurar a organização, acompanhar pagamentos, gerenciar o catálogo, convidar membros e acessar ferramentas de integração.

​
Desconto

Redução aplicada a um preço ou cobrança. Descontos podem ser configurados com valor fixo ou percentual e, quando aplicável, disponibilizados por meio de códigos. Veja Criar e aplicar descontos.

​
Disputa

Contestação de uma cobrança iniciada pelo titular do cartão junto ao emissor. A organização pode acompanhar o caso e enviar evidências enquanto o prazo estiver aberto. Veja Responder a disputas.

​
E

​
Escopo

Nível de acesso atribuído a uma chave de API. Os escopos de API são independentes da função que uma pessoa possui no Dashboard.

​
Evento

Registro imutável de algo relevante que ocorreu, como um pagamento concluído ou uma assinatura atualizada. Eventos podem ser consultados e enviados aos seus endpoints por webhook.

​
F

​
Forma de pagamento

Instrumento usado por um customer para pagar, como cartão, Pix ou boleto. Um payment_method de cartão pode ser salvo e reutilizado em cobranças futuras.

​
Fatura

Documento de cobrança representado pelo objeto invoice. Pode reunir itens avulsos ou ser gerado pelo ciclo de uma assinatura. Veja Faturas.

​
Função de usuário

Conjunto de permissões que controla o que um membro pode ver e fazer em uma organização pelo Dashboard. Veja Funções de usuário.

​
I

​
Idempotência

Mecanismo que permite repetir com segurança uma requisição de criação ou alteração sem produzir efeitos duplicados. Veja Idempotência.

​
Invoice

Nome do objeto de API usado para representar uma fatura. Uma invoice registra itens, valor devido, estado da cobrança e, quando aplicável, a assinatura relacionada.

​
L

URL reutilizável que abre um checkout hospedado com os produtos e preços configurados. Veja Criar um Link de pagamento.

​
Liquidação

Movimento do valor líquido de uma transação para a conta bancária cadastrada, de acordo com a agenda aplicável. A Chargefy não exige uma solicitação manual de saque. Veja Reconciliação de pagamentos.

​
M

​
Metadata

Conjunto opcional de pares de chave e valor anexado a um recurso para ajudar na reconciliação com o seu sistema. Metadata não altera o comportamento financeiro do objeto e não deve armazenar dados sensíveis.

​
Modo de teste

Ambiente isolado usado para desenvolver a integração sem movimentar dinheiro real. A organização precisa concluir a ativação antes de confirmar pagamentos, inclusive no modo de teste. Veja Testar pagamentos.

​
O

​
Organização

Espaço que reúne configurações, catálogo, customers, pagamentos, membros e perfil financeiro de um negócio. Um usuário pode participar de mais de uma organização e alternar entre elas no Dashboard.

​
P

​
Payment Intent

Objeto que acompanha uma intenção de pagamento desde a criação até o resultado final. Ele mantém o estado da operação e reúne as tentativas de cobrança relacionadas. Veja Payment Intents. Nome do objeto de API que representa um link de pagamento reutilizável.

​
Payment Method

Nome do objeto de API que representa uma forma de pagamento. O objeto guarda os dados reutilizáveis necessários ao processamento sem expor os dados sensíveis completos.

​
Plataforma

Organização que cria e opera organizações conectadas para outros negócios. A plataforma pode iniciar a ativação hospedada, atuar no contexto de uma organização conectada e aplicar sua própria experiência de produto. Veja Plataformas e organizações conectadas.

​
Preço

Configuração comercial de um produto. Um price define moeda, valor e se a cobrança é única ou recorrente. Veja Produtos, preços e descontos.

​
Produto

Item ou serviço que o negócio oferece. O produto guarda as informações de apresentação, enquanto um ou mais preços definem como ele é cobrado. Veja Produtos, preços e descontos.

​
R

​
Reembolso

Devolução total ou parcial de uma cobrança concluída. O reembolso possui estado próprio e não apaga a cobrança original. Veja Reembolsos.

​
S

​
Seller

Negócio que vende e recebe o valor líquido das transações. Na Chargefy, os dados e recursos de um seller ficam dentro de uma organização.

​
Cadastro de cartão (setup_intent)

Processo que salva um cartão para uso futuro sem cobrar, reservar limite ou movimentar dinheiro naquele momento. Veja Salvar cartão para cobrar depois.

​
Status

Estado atual de um recurso. Cada tipo de objeto possui seu próprio ciclo de vida; use o status retornado pela API e os eventos de webhook para decidir a próxima ação.

​
T

​
Transação

Movimento financeiro gerado por uma cobrança, reembolso ou outro ajuste suportado. O objeto transaction ajuda a reconciliar valores brutos, taxas, valor líquido e liquidação. Veja Ciclo de pagamento.

​
W

​
Webhook

Requisição HTTP enviada pela Chargefy ao seu servidor quando um evento ocorre. Webhooks permitem atualizar seu sistema sem consultar a API continuamente. Veja Entrega de webhooks.