Cancelar reclamo

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "USER_REQUESTED"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/cancel"

payload = { "reason": "USER_REQUESTED" }
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: 'USER_REQUESTED'})
};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/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://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/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' => 'USER_REQUESTED'
  ]),
  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://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"USER_REQUESTED\"\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://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"USER_REQUESTED\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/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\": \"USER_REQUESTED\"\n}"

response = http.request(request)
puts response.read_body

{
  "claimType": "OWNERSHIP",
  "claimerISPB": "12345678",
  "deadline": "2025-03-14T14:30:00Z",
  "donorISPB": "87654321",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "keyType": "CPF",
  "keyValue": "12345678901",
  "requestedAt": "2025-03-07T14:30:00Z",
  "status": "OPEN",
  "resolution": "",
  "resolvedAt": ""
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

POST

api

dict

claims

{claimID}

cancel

Cancelar reclamo

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "USER_REQUESTED"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/cancel"

payload = { "reason": "USER_REQUESTED" }
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: 'USER_REQUESTED'})
};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/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://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/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' => 'USER_REQUESTED'
  ]),
  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://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"USER_REQUESTED\"\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://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"USER_REQUESTED\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/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\": \"USER_REQUESTED\"\n}"

response = http.request(request)
puts response.read_body

{
  "claimType": "OWNERSHIP",
  "claimerISPB": "12345678",
  "deadline": "2025-03-14T14:30:00Z",
  "donorISPB": "87654321",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "keyType": "CPF",
  "keyValue": "12345678901",
  "requestedAt": "2025-03-07T14:30:00Z",
  "status": "OPEN",
  "resolution": "",
  "resolvedAt": ""
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

Idempotency-Key

string

Idempotency key, max 255 characters

Parámetros de ruta

claimID

string

requerido

Claim UUID

Cuerpo

application/json

Cancellation reason. The cancelling side is derived from the authenticated participant, not this body.

reason

string

requerido

Cancellation reason: USER_REQUESTED (participant withdrawal) or FRAUD (anti-fraud cancel, either side on either claim type)

Ejemplo:

"USER_REQUESTED"

Respuesta

Claim record with its current status and deadlines

claimType

string

requerido

Claim kind: OWNERSHIP or PORTABILITY

Ejemplo:

"OWNERSHIP"

claimerISPB

string

requerido

ISPB (8 numeric digits) of the participant initiating the claim

Ejemplo:

"12345678"

deadline

string

requerido

Donor-response deadline, seven days after initiation (RFC 3339, UTC)

Ejemplo:

"2025-03-14T14:30:00Z"

donorISPB

string

requerido

ISPB (8 numeric digits) of the current key owner (donor), resolved during initiation

Ejemplo:

"87654321"

string

requerido

Server-assigned claim UUID

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

keyType

string

requerido

PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP

Ejemplo:

"CPF"

keyValue

string

requerido

PIX key value under claim

Ejemplo:

"12345678901"

requestedAt

string

requerido

Claim initiation timestamp (RFC 3339, UTC)

Ejemplo:

"2025-03-07T14:30:00Z"

status

string

requerido

Claim lifecycle state: OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, or COMPLETED

Ejemplo:

"OPEN"

resolution

string

Terminal resolution reason (e.g. DONOR_CONFIRMED, CANCELLED_BY_CLAIMER, CANCELLED_BY_CLAIMER_FRAUD, CANCELLED_BY_DONOR, CANCELLED_BY_DONOR_FRAUD, DEADLINE_EXPIRED); empty until the claim resolves

Ejemplo:

""

resolvedAt

string

Resolution timestamp (RFC 3339, UTC); omitted while the claim is unresolved

Ejemplo:

""

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado — Dataprev

Cancelar reclamo

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta