Saltar al contenido principal
GET
/
v1
/
pix-automatico
/
authorizations
/
{idRecorrencia}
/
cancel
/
{idCancelamento}
Consultar una cancelación de autorización de Pix Automático
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "cancelStatus": 123,
  "idCancelamento": "<string>",
  "idRecorrencia": "<string>",
  "payer": {
    "account": "<string>",
    "accountType": 123,
    "agency": "<string>",
    "cpfCnpj": "<string>",
    "ibgeCode": 123,
    "ispb": "<string>",
    "name": "<string>",
    "personType": 123
  },
  "reason": 123,
  "recipient": {
    "cnpj": "<string>",
    "ispb": "<string>",
    "name": "<string>"
  },
  "requesterDocument": "<string>",
  "requesterType": 123,
  "cancelledAt": "<string>",
  "errorCode": "<string>",
  "errorDesc": "<string>",
  "situationAt": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Autorizaciones

Authorization
string
header
requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Parámetros de ruta

idRecorrencia
string
requerido

The recurrence id (29-char, RR...). El id de recurrencia (29 caracteres, RR...).

idCancelamento
string
requerido

The cancellation id (29-char, IC...). El id de cancelación (29 caracteres, IC...).

Respuesta

OK

cancelStatus
integer<int64>
requerido

stCancelamento (0=Aceito, 1=Rejeitado; -1 ausente).

idCancelamento
string
requerido

El id de cancelación (IC...).

idRecorrencia
string
requerido

El id de recurrencia.

payer
object
requerido
reason
integer<int64>
requerido

motivoCancelamento (0..10).

recipient
object
requerido
requesterDocument
string
requerido

CPF/CNPJ del solicitante (cadena).

requesterType
integer<int64>
requerido

tpPessoaSol.

cancelledAt
string

Marca de tiempo de la cancelación (UTC).

errorCode
string

Código de error del upstream.

errorDesc
string

Descripción del error del upstream.

situationAt
string

Marca de tiempo de la situación (UTC).