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 uma Ordem de Transação, através do ID da mesma. A 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

IdOrdemTransacaoidOrdemTransacao

Long

ID que identifica a ordem Ordem de pagamento 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

...

Schema:

Campo

Tipo

Descrição

IdOrdemTransacaoidOrdemTransacao

Long

ID que identifica a ordem de pagamento a ser buscadaIdEstabelecimentoOperadorOrdem de Transação

nsu

Long

Número Sequencial Único enviado pelo Parceiro

idEstabelecimentoOperador

Long

ID Que que identifica o operador que solicitou a ordem Ordem de pagamentoTransação

IdOrdemTransacaoStatusidOrdemTransacaoStatus

Int32

ID que identifica o Status da Ordem de Transação onde:

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

DescricaoStatus

.

descricaoStatus

String

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

IdRedeCredenciadaMetodoPagamentoidRedeCredenciadaMetodoPagamento

Long

ID que identifica a rede credenciada

Valorvalor

Decimal

Valor da ordem Ordem de pagamentoTransação

Ativoativo

Boolean

Campo que indica se a ordem Ordem de pagamento está ativaTransação está ativa

 

JSON:

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