Versions Compared

Key

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

...

...

DELETE     /api/broker/

...

ordemTransacao/nsu/{nsu}

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

...

Campo

Tipo

Descrição

Obrigatório

NSUnsu

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

...

Campo

Tipo

Descrição

idOrdemTransacao

Long

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

nsu

Long

Número Sequencial Único enviado pelo Parceiro

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

 

JSON:

Code Block
languagejson
{
    "idOrdemTransacao": 55,
    "nsu": 100000,
    "idEstabelecimentoOperador": 2,
    "idOrdemTransacaoStatus": 1,
    "descricaoStatus": "Cancelada",
    "idRedeCredenciadaMetodoPagamento": 2,
    "valor": 5.00,
    "ativo": false
}