...
...
DELETE
...
/api/broker/ordemTransacao/
...
id/{idOrdemTransacao}
Endpoint responsável por buscar as informações de uma ordem de pagamento pelo ID da ordem, retornando um body com os dados da ordemCancelar 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 |
IdOrdemTransacaoidOrdemTransacao | Int32Long | ID que identifica a Ordem de Transação a ser cancelada. Essa ordem de pagamento a ser buscadatambé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 | ||
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 | 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 Transação está ativa |
Exemplos de ImplementaçãoJSON:
| Code Block |
|---|
...
| |
| |
var client = new RestClient("https://localhost:44380/api/OrdemTransacao?Id=1");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImNhaW8uZm9udGVzIiwianRpIjoiZDVkMmQ4ZmVlMDgwNDk2MWE3ZjQ3NWY2MjRiMTkxYmQiLCJOZXRDb3JlVXNlcklkIjoiNjdjNjVhMDQtOTM0NC00MzE0LTYwYzgtMDhkN2RjMGNkMmI2IiwiUm9sZUxldmVsIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvT3BlcmFkb3IiOiIwIiwiSWRDbGllbnRlQnJva2VyIjpbIjAiLCIwIl0sInJvbGUiOiJFc3RhYmVsZWNpbWVudG8iLCJuYmYiOjE1OTIyNTk1ODcsImV4cCI6MTU5MjI2MzE4NywiaWF0IjoxNTkyMjU5NTkyLCJpc3MiOiJTc29BdWRpZW5jZSIsImF1ZCI6IlNzb0F1ZGllbmNlIn0.ktfw3Hooj022BX0A_Vhyv7qq0led91t71oSrTBkA3OU");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content); |
PHP
| Code Block |
|---|
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://localhost:44380/api/OrdemTransacao?Id=1", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImNhaW8uZm9udGVzIiwianRpIjoiZDVkMmQ4ZmVlMDgwNDk2MWE3ZjQ3NWY2MjRiMTkxYmQiLCJOZXRDb3JlVXNlcklkIjoiNjdjNjVhMDQtOTM0NC00MzE0LTYwYzgtMDhkN2RjMGNkMmI2IiwiUm9sZUxldmVsIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvT3BlcmFkb3IiOiIwIiwiSWRDbGllbnRlQnJva2VyIjpbIjAiLCIwIl0sInJvbGUiOiJFc3RhYmVsZWNpbWVudG8iLCJuYmYiOjE1OTIyNTk1ODcsImV4cCI6MTU5MjI2MzE4NywiaWF0IjoxNTkyMjU5NTkyLCJpc3MiOiJTc29BdWRpZW5jZSIsImF1ZCI6IlNzb0F1ZGllbmNlIn0.ktfw3Hooj022BX0A_Vhyv7qq0led91t71oSrTBkA3OU" ), )); $response = curl_exec($curl); curl_close($curl); echo $response;{ "idOrdemTransacao": 55, "nsu": 100000, "idEstabelecimentoOperador": 2, "idOrdemTransacaoStatus": 1, "descricaoStatus": "Cancelada", "idRedeCredenciadaMetodoPagamento": 2, "valor": 5.00, "ativo": false } |