Cancelamento de boleto bancário

Essa função é apenas com os boletos que ainda não foram pagos. Após o vencimento do boleto, o mesmo será cancelado automaticamente pela PAGHIPER após 4 dias corridos.

Endpoint
https://api.paghiper.com/transaction/cancel/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.
{ 
 "token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX", 
 "apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz", 
 "status":"canceled", 
 "transaction_id":"BPV661O7AVLORCN5" 
}
{
  "cancellation_request":
    {
    "result":"success",
    "response_message":"O Boleto BPV661O7AVLORCN5 foi cancelado com Sucesso",
    "http_code":"200"
    }
}
<?php
$data = array(
   'apiKey' => 'apk_12345678-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz',
'token' => 'ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEXl',
'status' => 'canceled',
'transaction_id' => 'ARC83YKF5TZ1XU50',
);
$data_post = json_encode( $data );
$url = "https://api.paghiper.com/transaction/cancel/";
//Configuracao do cabecalho da requisicao
$mediaType = "application/json";
$charSet = "UTF-8";
$headers = array();
$headers[] = "Accept: ".$mediaType;
$headers[] = "Accept-Charset: ".$charSet;
$headers[] = "Accept-Encoding: ".$mediaType;
$headers[] = "Content-Type: ".$mediaType.";charset=".$charSet;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_post);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$result = curl_exec($ch);
$json = json_decode($result, true);
### captura o http code
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if($httpCode == 201): // CÓDIGO 201 SIGNIFICA QUE O BOLETO FOI GERADO COM SUCESSO
echo $result; // exibe todo json
else:
echo $json['cancellation_request']['response_message']; // Exemplo de como capturar a resposta json
endif;
?>
Language
Response
Click Try It! to start a request and see the response here!