Saltar al contenido principal
POST
/
v1
/
claims
Crear reclamo
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "12345678901",
  "accountId": "0198f132-090a-7e01-85cb-839462585613"
}'
{
  "key": "+5511987654321",
  "type": 3,
  "status": 1,
  "claimId": "claim_abc123xyz",
  "statusDescription": "OPEN"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
key
string
required

Clave Pix que se desea reclamar.

Example:

"12345678901"

​
accountId
string<uuid>
required

Identificador de la cuenta del reclamante.

Example:

"0198f132-090a-7e01-85cb-839462585613"

Response

Reclamo creado correctamente

​
key
string
required

Valor de la clave Pix.

Example:

"+5511987654321"

​
type
enum<integer>
required

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
Example:

3

​
status
enum<integer>
required

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
Example:

1

​
claimId
string
required

Identificador único del reclamo.

Example:

"claim_abc123xyz"

​
statusDescription
string
required

Descripción legible del estado del reclamo.

Example:

"OPEN"