Versions Compared

Key

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

DELETE     /broker/ordemtransacao/{nsu}

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

NSU

Long

NSU que identifica a ordem de pagamento 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 pagamento a ser buscada

IdEstabelecimentoOperador

Long

ID Que identifica o operador que solicitou a ordem de pagamento

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 pagamento

Ativo

Boolean

Campo que indica se a ordem de pagamento está ativa