Skip to content

Verifica se um pedido é elegível a estorno automático

Request

Versão "pedido inteiro" da verificação de estorno automático: recebe o pedido e o valor pretendido do reembolso e responde se ele pode ser estornado automaticamente, conforme a configuração da conta e as características do pagamento.

Quando usar

Use no fluxo clássico (sem estorno por item), quando você tem o pedido e um valor único de reembolso. Se sua integração trabalha com múltiplos pagamentos e devolução item a item, prefira verificar-permissao-estorno-automatico-por-item.

Como o front Genius usa

O front consulta este endpoint ao montar a etapa de reembolso do fluxo tradicional, para decidir entre exibir "estorno automático" (com prazo estimado) ou "reembolso sujeito a análise".

Security
BearerAuth
Query
valornumber, (double)required

Valor pretendido do reembolso, em reais (ex.: 219.80).

lojaVirtualIdinteger or null, (int64)

Id da loja virtual (subconta), quando a conta opera múltiplas lojas.

Bodyapplication/jsonrequired

Pedido original, como retornado pela consulta de pedidos.

PedidoIdstring

Id do pedido no ecommerce.

Datastring, (date-time)

Data Hora do pedido.

Numerostring

Número do pedido no e-commerce.

Valornumber, (double)

Valor total do Pedido.

ValorFretenumber, (double)

Valor do Frete.

ValorDescontonumber, (double)

Valor de desconto.

IdTransportadoraEcommstring

Id da transportadora.

NomeTransportadoraEcommstring

Nome da transportadora.

ClienteEcommIdstring

Id do cliente na loja virtual.

ClienteNomestring

Nome do cliente da loja virtual.

ClienteEmailstring

Email do cliente.

ClienteDocumentostring

Documento do cliente da loja virtual.

ClienteTelefonestring

Telefone do cliente da loja virtual.

ClienteCelularstring

Celular do cliente da loja virtual.

Parcelasinteger

Número de parcelas do pedido.

QuantidadeItensinteger

Quantidade total de itens de pedido.

EstornoAutomaticoAtestring or null, (date-time)

Data máxima para estorno automático.

TransacaoCartaoCreditoIdstring or null

Se for compra por cartão, id da transação.

TransacaoCartaoCreditoValornumber or null, (double)

Se for compra por cartão o valor da transação.

Statusstring

Status do pedido.

PossuiValeCompraboolean

Foi utilizado um vale compras no pedido?

ClienteEnderecoobject(EnderecoDTO)

Representa um endereço físico

SkusArray of objects(SkuInputDTO)

Itens do pedido.

DataEntregastring or null, (date-time)

Data em que os pacotes do pedido foram entregues.

SelectedSlastring or null

SLA de entrega praticado pela loja virtual no pedido.

CustomerAddressIdstring or null
TransacoesArray of objects(TransacaoEcommDTO)

Transações de pagamento do pedido.

NotaNumerostring or null

Número da nota fiscal.

NotaValornumber or null, (double)

Valor da nota fiscal.

NotaChavestring or null

Chave da nota fiscal.

NotaSeriestring or null

Série da nota fiscal.

NotaDatastring or null, (date-time)

Data da nota fiscal.

curl -i -X POST \
  'https://apidocs.geniusreturns.com.br/_mock/openapi/v1/pvt/financeiro/verificar-elegibilidade-estorno-automatico?valor=0.1&lojaVirtualId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "PedidoId": "1234567890-01",
    "Numero": "PED-0001",
    "Data": "2026-09-01T12:00:00Z",
    "Valor": 219.8,
    "ValorFrete": 19.9,
    "QuantidadeItens": 1,
    "ClienteEmail": "maria@email.com"
  }'

Responses

Verificação concluída.

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).

entidadeboolean

Resultado da verificação.

Response
{
  "dataHoraResposta": "2026-09-18T13:44:52.640Z",
  "registros": 1,
  "httpStatus": "200",
  "entidade": true
}