Referência de status
Status do link de pagamento
| Valor | Label | Descrição |
|---|---|---|
| 0 | Novo | Link recém-criado |
| 1 | Pendente | Aguardando pagamento |
| 2 | Atrasado | Legado — não utilizar |
| 3 | Expirado | Prazo encerrado sem pagamento |
| 4 | Confirmado | Pago. Libere o pedido |
| 5 | Disputa | Chargeback aberto após o pagamento |
| 6 | Cancelado | Cancelado pelo lojista |
| 7 | Negado | Pagamento recusado. O pagador pode tentar outro cartão no mesmo link |
Status da venda avulsa (sale_status)
| Valor | approved | Descrição |
|---|---|---|
PRE_CAPTURED | true | Cartão autorizado aguardando captura, ou cobrança PIX aguardando pagamento |
CONFIRMED | true | Capturada (cartão) ou paga (PIX) |
CANCELED | false | Cancelada ou estornada |
DENIED | false | Recusada pelo adquirente. Motivo em denial |
EXPIRED | false | PIX não pago no prazo |
Status da assinatura (Subscription)
| Valor | Constante | Descrição |
|---|---|---|
| 0 | ACTIVE | Ativa — as cobranças são geradas automaticamente |
| 1 | CANCELED | Cancelada via API |
| 2 | EXPIRED | A endDate foi atingida |
| 3 | PENDING_PAYMENT | Aguardando o pagador informar o cartão |
Status da cobrança (Charge)
Representada como número no campo status das rotas de cobrança, e como texto em lastChargeStatus da assinatura e no status dos webhooks.
| Valor | Texto | Descrição |
|---|---|---|
| 0 | PENDING | Criada, aguardando processamento |
| 1 | CONFIRMED | Pagamento aprovado pelo adquirente |
| 2 | DENIED | Pagamento negado. Com nextRetryAt preenchido, ainda será tentado de novo |
| 3 | REFUNDED | Estornada — o valor voltou ao pagador |
lastChargeStatus nunca vem "PENDING": ele registra só resultados. Antes da primeira cobrança, é null.
Ciclos de cobrança
Envie o valor exatamente como na tabela, em maiúsculas.
| Valor | Descrição | Intervalo |
|---|---|---|
WEEKLY | Semanal | 7 dias |
BIWEEKLY | Quinzenal | 14 dias |
MONTHLY | Mensal | 1 mês |
QUARTERLY | Trimestral | 3 meses |
SEMIANNUALLY | Semestral | 6 meses |
YEARLY | Anual | 12 meses |
Vencimentos no fim do mês
Para ciclos mensais ou superiores, se o dia original não existir no mês seguinte, ele é ajustado para o último dia daquele mês. Uma assinatura que vence em 31 de janeiro terá o próximo vencimento em 28 de fevereiro — ou 29, em ano bissexto.