paymentDiscounts.list

Método do SDK — lista descontos por método de pagamento no checkout.

storefront.paymentDiscounts.list(options) retorna descontos por método de pagamento (PIX, boleto, cartão, etc.).

Tipo retornado: Desconto de pagamento.

---

Parâmetros

Campo	Tipo	Descrição
productIds	string[]	Produtos no contexto
cep	string	CEP
state	string	UF
subtotal	number	Subtotal do carrinho

---

Retorno

Connection<PaymentDiscount>

Apenas entradas enabled: true.

---

Exemplo — badge PIX na PDP

export const schema = defineSection({
  name: 'Desconto PIX',
  enabledOn: ['product'],
  data: ['payment_discounts'],
});

export const data = defineSectionData(async ({ storefront, page }) => ({
  payment_discounts: await storefront.paymentDiscounts.list({
    subtotal: page.product?.price?.amount,
  }),
}));

export default function PixBadge({ data }) {
  const pix = data.payment_discounts.nodes.find((entry) => entry.method === 'PIX');
  if (!pix) return null;

  return <span>PIX: {pix.amount}</span>;
}

---

Hook

const { data: payment_discounts } = useCorvexData('payment_discounts', {
  subtotal: cartTotal,
});

---

Declaração schema.data

data: ['payment_discounts']

Veja Mapa de dados.