DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

DELETE     /api/broker/ordemtransacao/{idOrdemTransacao}

Endpoint responsável por Cancelar uma Ordem de Transação, através do ID da mesma. 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

Status da Ordem de Transação onde:

1- Aguardando Leitura
2- Aguardando Pagamento
3- Processando
4- Sucesso
5- Falha
6- Cancelado

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


 

  • No labels