Saltar al contenido principal
POST
/
v1
/
claims
Crear reclamo
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "12345678901",
  "accountId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a"
}
'
import requests

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

payload = {
"key": "12345678901",
"accountId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a"
}
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({key: '12345678901', accountId: '019c96a0-0ac0-7de9-9f53-9cf842a2ee5a'})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/claims', 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",
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([
'key' => '12345678901',
'accountId' => '019c96a0-0ac0-7de9-9f53-9cf842a2ee5a'
]),
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"

payload := strings.NewReader("{\n \"key\": \"12345678901\",\n \"accountId\": \"019c96a0-0ac0-7de9-9f53-9cf842a2ee5a\"\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/claims")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"12345678901\",\n \"accountId\": \"019c96a0-0ac0-7de9-9f53-9cf842a2ee5a\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"key\": \"12345678901\",\n \"accountId\": \"019c96a0-0ac0-7de9-9f53-9cf842a2ee5a\"\n}"

response = http.request(request)
puts response.read_body
{
  "key": "+5511987654321",
  "type": 3,
  "status": 1,
  "claimId": "claim_abc123xyz",
  "statusDescription": "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).

Cuerpo

application/json
key
string
requerido

Clave Pix que se desea reclamar.

Ejemplo:

"12345678901"

accountId
string<uuid>
requerido

Identificador de la cuenta del reclamante.

Ejemplo:

"019c96a0-0ac0-7de9-9f53-9cf842a2ee5a"

Respuesta

Reclamo creado correctamente

key
string
requerido

Valor de la clave Pix.

Ejemplo:

"+5511987654321"

type
enum<integer>
requerido

Identificador del tipo de clave Pix. Códigos numéricos que especifican el tipo de clave Pix utilizada.

Valores válidos:

  • 0 = CPF (Identificación tributaria de persona física con 11 dígitos, p. ej., "12345678901")
  • 1 = CNPJ (Identificación tributaria de empresa con 14 dígitos, p. ej., "12345678000190")
  • 2 = EMAIL (Dirección de correo electrónico, p. ej., "user@example.com")
  • 3 = PHONE (Número telefónico en formato internacional, p. ej., "+5511987654321")
  • 4 = EVP (Clave aleatoria UUID generada automáticamente, p. ej., "123e4567-e89b-12d3-a456-426614174000")
Opciones disponibles:
0,
1,
2,
3,
4
Ejemplo:

3

status
enum<integer>
requerido

Código de estado del registro de la clave Pix. Indica el estado actual de una clave Pix en su ciclo de vida.

Valores válidos:

  • -1 = CANCELLED (El registro de la clave fue cancelado)
  • 0 = FINALIZED (La clave está finalizada/pendiente de confirmación)
  • 1 = ACTIVE (La clave está activa y operativa)
  • 2 = WAITING_OWNERSHIP_CONFIRMATION (En espera de la confirmación de titularidad por parte del usuario)
  • 3 = CREATING (La clave se está creando en el sistema)
  • 4 = IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST (Soy reclamante, pendiente de confirmación del reclamo)
  • 5 = IM_CLAIMER_PENDING_OWNER_GIVEWAY (Soy reclamante, esperando que el titular actual libere la clave)
  • 6 = IM_OWNER_PENDING_GIVEAWAY_CONFIRM (Soy titular, pendiente de aprobar la transferencia de la clave)
  • 7 = IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM (Transferencia iniciada, a la espera de mi confirmación)
Opciones disponibles:
-1,
0,
1,
2,
3,
4,
5,
6,
7
Ejemplo:

1

claimId
string
requerido

Identificador único del reclamo.

Ejemplo:

"claim_abc123xyz"

statusDescription
string
requerido

Descripción legible del estado del reclamo.

Ejemplo:

"OPEN"