Cancelar boleto
curl --request POST \
--url https://api.alphagateway.com.br/v1/boleto/cancel \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"idempotency": "boleto-3001"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({idempotency: 'boleto-3001'})
};
fetch('https://api.alphagateway.com.br/v1/boleto/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.alphagateway.com.br/v1/boleto/cancel"
payload = { "idempotency": "boleto-3001" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alphagateway.com.br/v1/boleto/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'idempotency' => 'boleto-3001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Boleto cancelado com sucesso!",
"response": {
"transactionId": "01961234-abcd-7000-8000-000000000003",
"idempotency": "boleto-3001",
"status": "CANCELED"
}
}{
"response": null,
"errors": [
"O valor da transação deve ser maior ou igual a R$1,00"
]
}{
"response": null,
"errors": [
"API key inválida ou expirada"
]
}{
"response": null,
"errors": [
"Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
]
}{
"response": null,
"errors": [
"Transação não encontrada"
]
}{
"response": null,
"errors": [
"Limite de requisições excedido"
]
}{
"response": null,
"errors": [
"Erro interno"
]
}{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}Boletos
Cancelar boleto
Cancela (baixa) um boleto registrado e ainda não pago.
POST
/
v1
/
boleto
/
cancel
Cancelar boleto
curl --request POST \
--url https://api.alphagateway.com.br/v1/boleto/cancel \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"idempotency": "boleto-3001"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({idempotency: 'boleto-3001'})
};
fetch('https://api.alphagateway.com.br/v1/boleto/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.alphagateway.com.br/v1/boleto/cancel"
payload = { "idempotency": "boleto-3001" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alphagateway.com.br/v1/boleto/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'idempotency' => 'boleto-3001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Boleto cancelado com sucesso!",
"response": {
"transactionId": "01961234-abcd-7000-8000-000000000003",
"idempotency": "boleto-3001",
"status": "CANCELED"
}
}{
"response": null,
"errors": [
"O valor da transação deve ser maior ou igual a R$1,00"
]
}{
"response": null,
"errors": [
"API key inválida ou expirada"
]
}{
"response": null,
"errors": [
"Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
]
}{
"response": null,
"errors": [
"Transação não encontrada"
]
}{
"response": null,
"errors": [
"Limite de requisições excedido"
]
}{
"response": null,
"errors": [
"Erro interno"
]
}{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}Autorizações
API Key da organização
Corpo
application/json
Identificador único informado na criação do boleto a ser cancelado.
Minimum string length:
1