API de Transações

Estornar Transação

Antes de prosseguir, certifique-se que leu todos os tópicos seção Primeiros Passos.

Estrutura

Para estornar uma transação é utilizada a estrutura, conforme Tabela 01:

Tabela 01 - Estornar Transação
Método POST
URL https://api.asteroidetecnologia.com.br
Recurso /transactions/refund
Endpoint https://api.asteroidetecnologia.com.br/transactions/refund

Request Body - JSON

Para estornar uma transação de cartão de crédito é preciso enviar o Request Body JSON, conforme exemplo: 

{
  "guid": "venda.5c3f9d4db89ca2.20185040",
  "motivo_cancelamento": "Cliente devolveu os produtos"
}

Parâmetros

Tabela 02 - Parâmetros Estornar Transação
Parâmetro Padrão Descrição
guid:String not null O identificador único da transação, que neste caso é guid retornado ao criar uma transação
motivo_cancelamento:String not null Uma mensagem explicando o motivo do cancelamento

Exemplos

Veja alguns exemplos de como realizar uma requisição à API de Transações enviando o Request Body JSON para solicitar o estorno de uma transação. 

# certifique-se de ter o comando "curl" instalado \

curl -X POST https://api.asteroidetecnologia.com.br/transactions/refund \
  -H 'Content-Type: application/json' \
  -H 'asteroide-key: SEU_TOKEN_AQUI' \
  -H 'asteroide-pass: SUA_SENHA_AQUI' \
  -d '{
  "guid": "venda.5c3e1f4bd815b3.53778551",
  "motivo_cancelamento": "Cliente devolveu os produtos"
}'
// certifique-se de ter a extensão php_curl instalada

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.asteroidetecnologia.com.br/transactions/refund',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => array(
        'Content-Type: application/json',
        'asteroide-key: SEU_TOKEN_ASTEROIDE',
        'asteroide-pass: SUA_SENHA_ASTEROIDE',
    ),
    CURLOPT_POSTFIELDS => json_encode(array(
        'guid' => 'venda.5c3e1f4bd815b3.53778551',
        'motivo_cancelamento' => 'Cliente devolveu os produtos'
    )),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo 'cURL Error #:' . $err;
} else {
    echo $response;
}
// No mesmo diretório do arquivo "package.json"
// npm install --save request

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.asteroidetecnologia.com.br/transactions/refund',
  headers: {
    'Content-Type': 'application/json',
    'asteroide-key': 'SEU_TOKEN_ASTEROIDE',
    'asteroide-pass': 'SUA_SENHA_ASTEROIDE'
  },
  json: true
  body :  {
    guid: "venda.5c3e1f4bd815b3.53778551",
    motivo_cancelamento: "Cliente devolveu os produtos"
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);
  console.log(body);
});

Retorno JSON

No caso de sucesso você deverá ver algo como:

{
    "http_status": 200,
    "body": {
        "seu_id": "ABC123",
        "codigo_pagamento": "10119011611382200172",
        "data_estorno": "2019-01-16 21:59:09"
    }
}