DOCUMENTAÇÃO CORPORATIVA
Cancelar Ordem de Transação por ID
- Ivan Saavedra (Unlicensed)
- Bruno Gorini (Unlicensed)
DELETE /api/broker/ordemTransacao/id/{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 |
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:
{
"idOrdemTransacao": 55,
"nsu": 100000,
"idEstabelecimentoOperador": 2,
"idOrdemTransacaoStatus": 1,
"descricaoStatus": "Cancelada",
"idRedeCredenciadaMetodoPagamento": 2,
"valor": 5.00,
"ativo": false
}