# Glossário

URL: https://staging.pagpolar.com/docs/guias/fundamentos/glossario

> Consulte o significado de cada termo usado nesta documentação e o campo da API que corresponde a ele.

Cada termo tem um único significado em toda a documentação.

## Termos da venda

| Termo                                 | Significado                                                                                                                                                                        | Campo na API                            |
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| **Cliente**                           | Pessoa que compra de você.                                                                                                                                                         | `customer` na API; `buyer` no webhook   |
| **Produto**                           | O que você vende. Veja [Criar produto e oferta](/docs/guias/jornadas/criar-produto-e-oferta).                                                                                      | `Product`                               |
| **Oferta**                            | Preço de venda de um produto, com meios de pagamento e parcelas.                                                                                                                   | `Offer`, `price`                        |
| **Valor mínimo do meio de pagamento** | Menor preço de oferta com que um meio de pagamento fica ligado. Não é a parcela mínima. Veja [Meios de pagamento](/docs/guias/jornadas/criar-produto-e-oferta#meios-de-pagamento). | `payment_methods`                       |
| **Parcela mínima**                    | Menor valor de cada parcela no cartão numa oferta avulsa. Veja [A regra da parcela mínima](/docs/guias/jornadas/criar-produto-e-oferta#parcela-minima).                            | `max_credit_card_installments`          |
| **Código da oferta**                  | Código que identifica a oferta, como `PPP1234567890`. Veja [Códigos com prefixo](/docs/guias/fundamentos/valores-datas-e-identificadores#codigos-com-prefixo).                     | `identifier`, `offer_identifier`        |
| **Oferta oculta**                     | Oferta criada na hora da cobrança que não aparece nas listagens. Veja [Oferta oculta](/docs/guias/conceitos/ofertas-planos-e-ofertas-ocultas#oferta-oculta).                       | `offer.createOffer`                     |
| **Venda**                             | Registro de uma cobrança a um cliente, com status próprio.                                                                                                                         | `Sale` na API; `transaction` no webhook |
| **Código da venda**                   | Código que identifica a venda, como `PPO0087103960`. Veja [Códigos com prefixo](/docs/guias/fundamentos/valores-datas-e-identificadores#codigos-com-prefixo).                      | `identifier`, `sale_identifier`         |
| **Referência externa**                | Código do seu pedido, enviado por você na cobrança.                                                                                                                                | `external_reference`                    |
| **Cobrança**                          | O pedido de pagamento feito ao cliente por PIX, boleto ou cartão.                                                                                                                  | —                                       |
| **Gateway**                           | Empresa que processa o pagamento e confirma, recusa ou estorna. No ambiente de testes é um [gateway de testes](/docs/guias/fundamentos/ambientes#dados-de-teste).                  | —                                       |
| **Afiliado**                          | Pessoa que divulga o produto e recebe comissão pela venda.                                                                                                                         | `affiliate_identifier`                  |
| **Pedido de reembolso**               | Pedido do cliente para devolver o dinheiro, total ou parcial.                                                                                                                      | `GET /refunds`                          |
| **Estorno**                           | Devolução efetiva do dinheiro pelo gateway. A venda fica `REFUNDED`.                                                                                                               | `TRANSACTION_REFUNDED`                  |
| **Chargeback**                        | Contestação da compra pelo banco do cliente.                                                                                                                                       | `TRANSACTION_CHARGEBACK_APPROVED`       |
| **Canal da venda**                    | Por onde a venda nasceu: checkout, API, venda manual ou prêmio de afiliado.                                                                                                        | `source.channel` no webhook             |

## Termos da assinatura

| Termo                 | Significado                                                                                                | Campo na API                           |
| --------------------- | ---------------------------------------------------------------------------------------------------------- | -------------------------------------- |
| **Plano**             | Produto do tipo assinatura.                                                                                | `type: SUBSCRIPTION`                   |
| **Oferta de plano**   | Preço recorrente de um plano, com ciclo.                                                                   | `cycle`: `WEEKLY`, `MONTHLY`, `YEARLY` |
| **Ciclo**             | Intervalo entre duas cobranças da assinatura. Na venda, `cycle` é a posição do ciclo: 1, 2, 3...           | `cycle`, `cycle_interval`              |
| **Assinatura**        | Vínculo de um cliente com uma oferta de plano, cobrado a cada ciclo.                                       | `Subscription`                         |
| **Prazo de carência** | Dias depois da data de renovação em que uma assinatura PIX ou boleto ainda pode ser paga antes de expirar. | —                                      |

## Termos da integração

| Termo                     | Significado                                                                                                                                                             | Campo na API                                 |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| **Vendedor**              | Dono da conta PagPolar que integra o próprio sistema. Nesta documentação, "você".                                                                                       | —                                            |
| **Credencial**            | Registro que dá acesso à API, com ambiente, IPs autorizados e webhook próprio.                                                                                          | `credential_id` em `GET /me`                 |
| **Chave de API**          | Valor secreto trocado pelo token de acesso. Veja [Autenticação](/docs/guias/fundamentos/autenticacao).                                                                  | `X-API-Key`                                  |
| **Token de acesso**       | Valor devolvido por `POST /auth/token` que autentica as outras rotas. Veja [Validade do token](/docs/guias/fundamentos/autenticacao#validade).                          | `access_token`                               |
| **Token do webhook**      | Valor que a PagPolar envia em cada aviso para você confirmar que ele é dela. Veja [Autenticar as requisições](/docs/webhooks/autenticar-requisicoes).                   | `webhook_authorization`                      |
| **Ambiente**              | Produção ou Homologação. Define onde a chamada é processada: na sua conta ou no ambiente de testes.                                                                     | `environment`: `PRODUCTION`, `STAGING`       |
| **Produção**              | Ambiente da chave `pgp_live_`. As chamadas agem na sua conta e as cobranças são reais.                                                                                  | `environment: PRODUCTION`                    |
| **Homologação**           | Ambiente da chave `pgp_test_`. As chamadas, com a chave ou com o token dela, vão para o ambiente de testes.                                                             | `environment: STAGING`                       |
| **Ambiente de testes**    | Ambiente separado da sua conta real, onde nada é cobrado de verdade. Veja [Ambiente de testes](/docs/guias/fundamentos/ambientes#ambiente-de-testes).                   | —                                            |
| **Conta de testes**       | Conta criada pela PagPolar no ambiente de testes quando você cria a chave de Homologação.                                                                               | —                                            |
| **Playground**            | Botão **Send** das páginas da Referência da API, que executa a operação no ambiente de testes. Veja [Testar pelo portal](/docs/guias/fundamentos/ambientes#playground). | —                                            |
| **Webhook**               | Requisição `POST` que a PagPolar envia ao seu servidor quando algo acontece.                                                                                            | —                                            |
| **Evento**                | Tipo do acontecimento avisado pelo webhook.                                                                                                                             | `event`                                      |
| **Entrega**               | Cada envio de um evento para a sua URL, com sucesso ou falha.                                                                                                           | —                                            |
| **Chave de idempotência** | Valor único por operação que evita cobrar duas vezes. Veja [Idempotência](/docs/guias/fundamentos/idempotencia).                                                        | `Idempotency-Key`                            |
| **Limite de requisições** | Máximo de chamadas por minuto da credencial. Veja [Limites de requisição](/docs/guias/fundamentos/limites-de-requisicao).                                               | `rate_limit_per_minute`, `X-RateLimit-Limit` |
