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

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

payload = {
"reason": 123,
"recipientIspb": "<string>",
"reconciliationId": "<string>",
"requester": 123,
"requesterDocument": "<string>",
"requesterIspb": "<string>",
"requesterPersonType": 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,
recipientIspb: '<string>',
reconciliationId: '<string>',
requester: 123,
requesterDocument: '<string>',
requesterIspb: '<string>',
requesterPersonType: 123
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/{endToEndId}/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/schedules/{endToEndId}/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,
'recipientIspb' => '<string>',
'reconciliationId' => '<string>',
'requester' => 123,
'requesterDocument' => '<string>',
'requesterIspb' => '<string>',
'requesterPersonType' => 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/schedules/{endToEndId}/cancel"

payload := strings.NewReader("{\n \"reason\": 123,\n \"recipientIspb\": \"<string>\",\n \"reconciliationId\": \"<string>\",\n \"requester\": 123,\n \"requesterDocument\": \"<string>\",\n \"requesterIspb\": \"<string>\",\n \"requesterPersonType\": 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/schedules/{endToEndId}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": 123,\n \"recipientIspb\": \"<string>\",\n \"reconciliationId\": \"<string>\",\n \"requester\": 123,\n \"requesterDocument\": \"<string>\",\n \"requesterIspb\": \"<string>\",\n \"requesterPersonType\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/{endToEndId}/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 \"recipientIspb\": \"<string>\",\n \"reconciliationId\": \"<string>\",\n \"requester\": 123,\n \"requesterDocument\": \"<string>\",\n \"requesterIspb\": \"<string>\",\n \"requesterPersonType\": 123\n}"

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

endToEndId
string
requerido

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

Cuerpo

application/json
reason
integer<int64>
requerido

motivoCancelamento (0..6).

recipientIspb
string
requerido

ISPB del participante de destino (ispbDestinatario, cadena).

reconciliationId
string
requerido

Id de conciliación del receptor (idConciliacaoRecebedor).

requester
integer<int64>
requerido

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

requesterDocument
string
requerido

CPF/CNPJ del solicitante (cpfCnpjSolCancelamento, cadena).

requesterIspb
string
requerido

ISPB del participante solicitante (ispbSolicitante, cadena).

requesterPersonType
integer<int64>
requerido

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

Respuesta

Aceptado

cancelledAt
string
requerido

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

endToEndId
string
requerido

El id de la transacción de pago (reflejado).

idCancelamento
string
requerido

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

reconciliationId
string
requerido

El id de conciliación del receptor (reflejado).

status
string
requerido

El estado local resultante de la programación.