Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

DELETE   /api/broker/ordemtransacao/id/{idOrdemTransacao}

Endpoint responsável por Cancelar a Transação de uma Ordem de Abastecimento. Enquanto não houver movimentação financeira a Ordem em questão receberá o Status de Cancelada. No caso onde a movimentação financeira já estiver ocorrido esta Ordem receberá o Status de Estornada e o valor da venda será devolvido ao Pagante. Em ambos os casos a Ordem será Inativada, não permitindo assim uma Confirmação de Pagamento para a mesma.

Headers    

Content-Type

application/json

Authorization

Bearer {token}

 

Request Query String    application/json

Schema:

Campo

Tipo

Descrição

Obrigatório

IdOrdemTransacao

Long

ID que identifica a Ordem de Transação a ser cancelada. Essa ordem também receberá o Status de Inativa não permitindo, a partir desse momento, a sua reativação.

Sim

 

Response Body    application/json

Schema:

Campo

Tipo

Descrição

idOrdemTransacao

Long

ID que identifica a Ordem de Transação que foi cancelada

idEstabelecimentoOperador

Long

ID que identifica o operador que solicitou a Ordem de Transação

idOrdemTransacaoStatus

Int32

ID que identifica o Status da Ordem de Transação.

descricaoStatus

String

Descrição do Status da Ordem Transação

idRedeCredenciadaMetodoPagamento

Long

ID que identifica a rede credenciada

valor

Decimal

Valor da Ordem de Transação

ativo

Boolean

Campo que indica se a Ordem de Transação está ativa

...