PayZu Gateway
Glossário
| Termo | O que é |
|---|---|
| Adesão | Fatura do ciclo 0, criada junto com a assinatura. Paga, ela ativa a assinatura. |
| Assinatura | Cobrança recorrente de um cliente, que guarda o nome, o valor e a periodicidade combinados e gera uma fatura a cada ciclo. |
| Assinatura avulsa | Assinatura sem plano, com nome, valor e periodicidade enviados na criação. |
| Carência | Prazo em que a fatura do ciclo não paga segue aberta e a assinatura segue active. Termina no billing.expires_at da fatura, 7 dias depois do vencimento por padrão, com prazo de 0 a 30 dias. |
| Cartão salvo | Cartão guardado no cadastro do cliente para cobranças futuras. |
| Chave de API | Credencial do seu servidor, que vai em Authorization: Bearer nas chamadas à API. |
| Chave de checkout | Chave pública da conta, usada no token de cartão e nas rotas de plano e de assinatura do checkout. |
| Chave de tokenização | Chave pública do painel que o script do navegador usa para cifrar o cartão. |
| Checkout | Rotas para assinar um plano, comprar pelo link e pagar uma fatura numa página sua. |
| Ciclo | Cada período cobrado da assinatura, com a própria fatura, numerado em billing.cycle_number a partir do 0, que é a adesão. |
| Cliente | Quem paga, identificado pelo CPF ou CNPJ, com o endereço em address. |
| Contestação | Pedido do portador do cartão, pela bandeira, para desfazer uma compra. |
| Devolução | Estorno de uma fatura paga no Pix, em que o valor volta ao pagador. É pedida na hora e confirmada depois. |
| Entrega | Envio de um evento a um webhook, com as tentativas e o resultado. |
| Estorno | Fatura paga desfeita pelo valor total, no cartão ou no Pix. |
| Evento | Aviso de uma mudança, como invoice.paid, enviado aos webhooks que o escolheram. |
external_reference | O identificador do pedido no seu sistema, enviado na criação da fatura e usado como filtro na lista de faturas. |
| Fatura | Toda cobrança do PayZu Gateway, seja uma venda, um ciclo de assinatura ou uma compra pelo link, com valor, prazo e página de pagamento. |
| Fatura sem cliente | Fatura criada sem customer_id nem customer. Quem paga informa os dados na página, e só a página recebe o pagamento. |
Idempotency-Key | Cabeçalho que impede que a mesma escrita rode duas vezes. |
| Link de pagamento | Link de valor fixo, criado no painel, para vender a várias pessoas. Cada compra cria uma fatura sem cliente. |
metadata | Mapa de textos com dados do seu sistema, guardado no recurso. |
| Página de pagamento | Página da PayZu, na url de toda fatura, em que o cliente paga no cartão ou no Pix. O endereço não muda nem vence, e a fatura paga serve de comprovante. |
| Pagamento em duplicidade | Pagamento confirmado numa fatura que já estava paga. A PayZu devolve o valor sozinha, e o status da fatura não muda. |
| Plano | Modelo com nome, valor e periodicidade para as assinaturas novas. |
| Recorrência | Recurso da conta, ativado no painel, que libera planos, assinaturas e as configurações da conta. |
| Tentativa de pagamento | Cada cobrança no cartão ou no Pix feita numa fatura, guardada em payments[]. Uma tentativa recusada não fecha a fatura. |
| Token de cartão | Cartão cifrado que vale 15 minutos e serve para uma operação só. |
| Webhook | Endereço do seu sistema que recebe os eventos escolhidos. |