Cancel a Pix Automático schedule

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"
}

POST

pix-automatico

schedules

{endToEndId}

cancel

Cancel a Pix Automático schedule

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"
}

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).

Body

application/json

reason

integer<int64>

required

motivoCancelamento (0..6).

recipientIspb

string

required

Destination participant ISPB (ispbDestinatario, string).

reconciliationId

string

required

Receiver conciliation id (idConciliacaoRecebedor).

requester

integer<int64>

required

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

requesterDocument

string

required

Requester CPF/CNPJ (cpfCnpjSolCancelamento, string).

requesterIspb

string

required

Requester participant ISPB (ispbSolicitante, string).

requesterPersonType

integer<int64>

required

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

Response

Accepted

cancelledAt

string

required

Cancellation timestamp (dtHrCancelamento, UTC).

endToEndId

string

required

The payment-transaction id (echoed).

idCancelamento

string

required

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

reconciliationId

string

required

The receiver conciliation id (echoed).

status

string

required

The resulting local schedule status.

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Cancel a Pix Automático schedule

Authorizations

Path Parameters

Body

Response