Skip to content

Calcula o valor do reembolso e o texto a exibir ao consumidor

Request

Calcula quanto será devolvido em um processo, aplicando a regra de frete configurada na conta, e devolve junto a frase pronta para exibição ao consumidor.

Por que existe

A parte difícil do reembolso é o frete: dependendo da configuração, ele é devolvido integralmente, proporcionalmente aos itens devolvidos, apenas quando o pedido inteiro é devolvido, ou nunca. Reimplementar essas variações do lado do cliente gera divergência entre o valor prometido na tela e o valor efetivamente estornado. Este endpoint elimina esse risco: o mesmo cálculo que a Genius usará no estorno é o que você exibe.

O campo texto já vem formatado e contextualizado (ex.: "R$ 219,89 (frete incluso)"), pronto para renderizar sem pós-processamento.

Como o front Genius usa

Na montagem do resumo do reembolso (MontarDadosEstornoPorItem), o front envia o processo em construção — com itens selecionados, valor do pedido, frete e a definição de vale-compra escolhida — e usa o texto retornado diretamente no rótulo "Valor total a receber".

Parâmetro tipoEstorno

Deve refletir a regra de frete da conta (campo TipoFreteEstorno da configuração). Veja os valores possíveis em EnumTipoFreteEstorno.

Security
BearerAuth
Query
tipoEstornointeger(EnumTipoFreteEstorno)required

Regra de estorno de frete a aplicar no cálculo. Use o valor configurado na conta (TipoFreteEstorno). Ver EnumTipoFreteEstorno.

Enum:-1012345
Bodyapplication/jsonrequired

Processo (em construção ou existente) sobre o qual o valor será calculado. Os campos relevantes são o pedido associado, seus itens selecionados, o valor do frete e a definição de vale-compra, quando o reembolso for nessa modalidade.

ClienteIPstring

IP do cliente.

LojaFisicaIdinteger or null, (int64)

Id da Loja Física.

LojaFisicaResumostring or null

Resumo Loja Física.

TransportadoraIdinteger or null, (int64)

Id da Transportadora.

ServicoLogisticoIdinteger or null, (int64)

Em caso de hub logístico, o id do serviço assinalado será armazenado.

HubQuotationIdstring or null
HubQuotationValuenumber or null, (double)
TransportadoraTipoEntregainteger(EDTipoEntregaReversa)

Tipo de entrega transportadora (0 para Postagem em agância, 1 ou 2 para coleta domiciliar, 3 para coleta expressa e 4 para postagem em lockers)

Enum:-101234
LogisticaPremiumValornumber or null, (double)

Quando logística premium fornecido ao cliente, este campo conterá o valor a ser pago.

MantenhaOItemboolean or null

True quando a solicitação faz jus à funcionalidade KeepTheItem.

ValorEstimadoLRnumber or null, (double)

Valor estimado de LR.

DadosBancariosDtoobject(DadosBancariosDTO)

Dados bancários do cliente para reembolso quando não for cartão de crédito

Pedidoobject(PedidoInputDTO)

Representa um pedido realizado na loja virtual.

ValeCompraobject(ValeCompraInputDTO)

Representa um vale-compras.

Cashbackobject(CashbackDTO)

Representa um cashback.

PostoPostagemobject(PostoPostagemBaseDTO)

Representa um posto para postagem de produtos a serem devolvidos ao lojista (lockers).

LojaVirtualobject

Representa a loja virtual em que a solicitação foi feita.

Agenteobject

Informado quando um usuário do admin cadastra o processo.

NotificarNovaSolicitacaoboolean

true ou false para notificar a nova solicitação.

Marketplaceboolean

true se marketplace; do contrário, false.

TipoFreteEstornointeger or null(EPedidoItemEstorno)

Tipo de estorno do frete (0 para frete em vale-compra, 1 para estorno manual e 2 para estorno automático).

Enum:012
ValeComprasBonusboolean

True se vale-compras bonus.

curl -i -X POST \
  'https://apidocs.geniusreturns.com.br/_mock/openapi/v1/pvt/financeiro/calcular-valor-etexto-estorno?tipoEstorno=-1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Marketplace": false,
    "Pedido": {
      "Numero": "PED-0001",
      "Valor": 199.9,
      "ValorFrete": 19.9,
      "QuantidadeItens": 1,
      "Skus": [
        {
          "SkuId": "SKU-1",
          "Preco": 199.9,
          "Quantidade": 1,
          "QuantidadeTotal": 1,
          "TipoProcesso": 1
        }
      ]
    }
  }'

Responses

Cálculo realizado.

Bodyapplication/json
dataHoraRespostastring, (date-time)

Data e hora da resposta, em UTC.

registrosinteger, (int32)

Quantidade de registros retornados em entidade.

httpStatusstring

Código HTTP da resposta, em texto.

erroCodigostring or null

Código do erro, quando houver.

erroDescricaostring or null

Mensagem do erro, quando houver.

erroDetalhadostring or null

Detalhamento técnico do erro, quando houver.

erroTipostring or null

Classificação do erro. Útil para distinguir falha de integração com a plataforma de e-commerce (04) de erro de domínio ou erro comum (00).

entidadeobject(EstornoTextoValorModel)

Valor calculado do reembolso e o texto correspondente para exibição.

Response
{
  "dataHoraResposta": "2026-09-18T13:34:19.220Z",
  "registros": 1,
  "httpStatus": "200",
  "entidade": {
    "valor": 219.8,
    "texto": "R$ 219,80 (frete incluso)"
  }
}