Y Yuupe Pay API v1Painel
Depois da venda

Estornos

Devolva o valor total ou parte dele. A chave de idempotência garante que um estorno repetido não devolve duas vezes.

Estornar

POST/pedidos/{id}/estornos
cURL
curl -X POST "https://yuupe.me/api/v1/pay/pedidos/3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90/estornos" \
  -H "Authorization: Bearer yp_test_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: estorno-NIC-2026-000123-1" \
  -d '{ "valor_centavos": 7990, "motivo": "Cliente desistiu da visita" }'
Resposta 201
{
  "estorno": { "id": "…", "valor_centavos": 7990, "motivo": "Cliente desistiu da visita", "status": "concluido", "criado_em": "…", "concluido_em": "…" },
  "pedido": { "id": "…", "status": "estorno_parcial", "valor_estornado_centavos": 7990, "…": "…" }
}

Para listar os estornos de um pedido: GET /pedidos/{id}/estornos.

Cartão e Pix

CartãoPix
TotalSimSim
ParcialSim, vários, até o valor pagoSim
PrazoNa hora; na fatura do comprador conforme o bancoNa hora se ainda não liquidado; depois, até 5 dias (estorno_em_processamento)
AvisoWebhook pedido.estornado ou pedido.estorno_parcial quando concluir

O estorno e o seu repasse

Quando uma venda é paga, a sua parte vai para a sua conta digital na operadora no prazo do repasse (Pix no mesmo dia, cartão em D+2). Quando você estorna, o comprador recebe o valor de volta e a operadora desconta a sua parte da sua conta digital, total ou proporcional no parcial. Nada muda na API.

Já numa contestação (chargeback) o valor sai da conta da Yuupe, e a sua parte fica como saldo a compensar: nas próximas vendas, a Yuupe retém a sua parte até cobrir o saldo. Você vê o valor retido em cada venda em Vendas › pedido. Sem vendas novas, o saldo pode ser cobrado na fatura mensal, combinado com você.

Contestações (chargeback)

Quando o comprador não reconhece a compra no cartão, a operadora abre uma contestação. A Yuupe registra o caso com o prazo de resposta: o pedido passa a contestado e você recebe o webhook pedido.contestado. Se a contestação for ganha, o pedido volta ao status anterior; se for perdida, vira estorno e chegapedido.estornado. Enquanto estiver em aberto, a sua parte do valor fica como saldo a compensar.

Erros do estorno

ErroQuando
400 idempotency_key_obrigatoriaFaltou o cabeçalho Idempotency-Key
409 valor_acima_do_estornavelValor maior que o saldo ainda não estornado
409 estorno_nao_permitidoPedido não pago (ou já estornado por completo)
502 erro_gatewayA operadora recusou o estorno; a mensagem traz o motivo