Saltar al contenido principal
DELETE
/
v1
/
claims
/
{claimId}
Cancelar reclamo
curl --request DELETE \
  --url https://plugin-pix-direct.api.lerian.net/v1/claims/{claimId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "11122233344",
  "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081"
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/claims/{claimId}"

payload = {
"key": "11122233344",
"accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({key: '11122233344', accountId: '019c96a0-0c0c-7221-8cf3-13313fb60081'})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/claims/{claimId}', 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/claims/{claimId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'key' => '11122233344',
'accountId' => '019c96a0-0c0c-7221-8cf3-13313fb60081'
]),
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/claims/{claimId}"

payload := strings.NewReader("{\n \"key\": \"11122233344\",\n \"accountId\": \"019c96a0-0c0c-7221-8cf3-13313fb60081\"\n}")

req, _ := http.NewRequest("DELETE", 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.delete("https://plugin-pix-direct.api.lerian.net/v1/claims/{claimId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"11122233344\",\n \"accountId\": \"019c96a0-0c0c-7221-8cf3-13313fb60081\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/claims/{claimId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"11122233344\",\n \"accountId\": \"019c96a0-0c0c-7221-8cf3-13313fb60081\"\n}"

response = http.request(request)
puts response.read_body
{
  "claimId": "claim_abc123xyz",
  "status": "OPEN"
}

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

claimId
string
requerido

Identificador del reclamo.

Cuerpo

application/json
key
string
requerido

Clave Pix cuya reclamación se desea cancelar.

Ejemplo:

"11122233344"

accountId
string<uuid>
requerido

Identificador de la cuenta del reclamante.

Ejemplo:

"019c96a0-0c0c-7221-8cf3-13313fb60081"

Respuesta

Reclamo cancelado correctamente

claimId
string
requerido

Identificador único del reclamo.

Ejemplo:

"claim_abc123xyz"

status
enum<string>
requerido

Estado del reclamo de titularidad de la clave Pix. Valores en texto que representan el estado de un reclamo de portabilidad o titularidad.

Valores válidos:

  • OPEN = El reclamo fue iniciado y está a la espera de acciones de las partes involucradas
  • CONFIRMED = El reclamo fue confirmado por quien lo solicitó
  • COMPLETED = El proceso de reclamo se completó con éxito y la clave fue transferida
  • CANCELLED = El reclamo fue cancelado por el reclamante o por el sistema
  • AWAITING_RESOLUTION = En espera de resolución o decisión del titular actual de la clave
Opciones disponibles:
OPEN,
CONFIRMED,
COMPLETED,
CANCELLED,
AWAITING_RESOLUTION
Ejemplo:

"OPEN"