Skip to main content
GET
/
v1
/
pix-automatico
/
schedules
/
{endToEndId}
/
cancel
/
{idCancelamento}
Consult a Pix Automático schedule cancellation
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"
}

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Path Parameters

endToEndId
string
required

The payment-transaction id (32-char).

idCancelamento
string
required

The cancellation id (29-char, CA...).

Response

OK

cancelStatus
integer<int64>
required

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

endToEndId
string
required

The payment-transaction id.

idCancelamento
string
required

The cancellation id (CA...).

localStatus
string
required

Local ScheduleStatus projected from the upstream situation.

localStatusKnown
boolean
required

False when the upstream situation carries no projected local status.

reason
integer<int64>
required

motivoCancelamento (0..6).

recipientIspb
string
required

ispbDestinatario (string).

requester
integer<int64>
required

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

requesterDocument
string
required

Requester CPF/CNPJ (string).

requesterIspb
string
required

ispbSolicitante (string).

requesterType
integer<int64>
required

tpPessoaSol.

stJdPi
integer<int64>
required

Upstream overall situation.

stJdPiProc
integer<int64>
required

Upstream intermediate situation.

cancelledAt
string

Cancellation timestamp (UTC).

errorCode
string

Upstream error code.

errorDesc
string

Upstream error description.

reconciliationId
string

The receiver conciliation id.

requestedAt
string

Upstream request timestamp (UTC).

situationAt
string

Situation timestamp (UTC).