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

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/{endToEndId}/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/schedules/{endToEndId}/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/schedules/{endToEndId}/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/schedules/{endToEndId}/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/schedules/{endToEndId}/cancel/{idCancelamento}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/{endToEndId}/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,
  "endToEndId": "<string>",
  "idCancelamento": "<string>",
  "localStatus": "<string>",
  "localStatusKnown": true,
  "reason": 123,
  "recipientIspb": "<string>",
  "requester": 123,
  "requesterDocument": "<string>",
  "requesterIspb": "<string>",
  "requesterType": 123,
  "stJdPi": 123,
  "stJdPiProc": 123,
  "cancelledAt": "<string>",
  "errorCode": "<string>",
  "errorDesc": "<string>",
  "reconciliationId": "<string>",
  "requestedAt": "<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

endToEndId
string
requerido

The payment-transaction id (32-char). El id de la transacción de pago (32 caracteres).

idCancelamento
string
requerido

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

Respuesta

OK

cancelStatus
integer<int64>
requerido

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

endToEndId
string
requerido

El id de la transacción de pago.

idCancelamento
string
requerido

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

localStatus
string
requerido

ScheduleStatus local proyectado desde la situación del upstream.

localStatusKnown
boolean
requerido

False cuando la situación del upstream no lleva ningún estado local proyectado.

reason
integer<int64>
requerido

motivoCancelamento (0..6).

recipientIspb
string
requerido

ispbDestinatario (cadena).

requester
integer<int64>
requerido

solCancelamento (0=PSP pagador, 1=PSP recebedor).

requesterDocument
string
requerido

CPF/CNPJ del solicitante (cadena).

requesterIspb
string
requerido

ispbSolicitante (cadena).

requesterType
integer<int64>
requerido

tpPessoaSol.

stJdPi
integer<int64>
requerido

Situación general del upstream.

stJdPiProc
integer<int64>
requerido

Situación intermedia del upstream.

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.

reconciliationId
string

El id de conciliación del receptor.

requestedAt
string

Marca de tiempo de la solicitud en el upstream (UTC).

situationAt
string

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