Saltar al contenido principal
POST
/
v1
/
pix-automatico
/
authorizations
/
{idRecorrencia}
/
cancel
Cancelar una autorización de Pix Automático
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": 123,
  "requesterDocument": "<string>",
  "requesterType": 123
}
'
import requests

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

payload = {
    "reason": 123,
    "requesterDocument": "<string>",
    "requesterType": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 123, requesterDocument: '<string>', requesterType: 123})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel', 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",
  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([
    'reason' => 123,
    'requesterDocument' => '<string>',
    'requesterType' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

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

func main() {

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

	payload := strings.NewReader("{\n  \"reason\": 123,\n  \"requesterDocument\": \"<string>\",\n  \"requesterType\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": 123,\n  \"requesterDocument\": \"<string>\",\n  \"requesterType\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": 123,\n  \"requesterDocument\": \"<string>\",\n  \"requesterType\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "cancelledAt": "<string>",
  "idCancelamento": "<string>",
  "idRecorrencia": "<string>",
  "status": "<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...).

Cuerpo

application/json
reason
integer<int64>
requerido

motivoCancelamento (0..10).

requesterDocument
string
requerido

CPF/CNPJ del solicitante (cpfCnpjSolCancelamento, cadena).

requesterType
integer<int64>
requerido

tpPessoaSol (0=Pessoa Fisica, 1=Pessoa Juridica).

Respuesta

OK

cancelledAt
string
requerido

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

idCancelamento
string
requerido

El id de cancelación (29 caracteres, IC...).

idRecorrencia
string
requerido

El id de recurrencia.

status
string
requerido

El estado local resultante de la autorización.