Pular para o conteúdo principal
POST
/
v1
/
dict
/
claims
Criar uma Reivindicação
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "key": "+5561988887777",
  "type": "OWNERSHIP"
}
'
{
  "id": "019c96a0-0c3e-77b5-8321-4807058a67bb",
  "bacenClaimId": "019c96a0-0d16-7184-ad7f-38545eeb671c",
  "key": "+5561988887777",
  "keyType": "PHONE",
  "type": "OWNERSHIP",
  "status": "OPEN",
  "donorParticipant": "30306294",
  "resolutionPeriodEnd": "2024-01-22T10:30:00Z",
  "completionPeriodEnd": "2024-01-29T10:30:00Z",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Autorizações

​
Authorization
string
header
obrigatório

Header de autenticação Bearer no formato Bearer <token>, onde <token> é o seu token de acesso JWT.

Cabeçalhos

​
X-Account-Id
string
obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

Corpo

application/json
​
key
string
obrigatório

Valor da chave PIX a reivindicar.

Exemplo:

"+5561988887777"

​
type
enum<string>
obrigatório

Tipo de reivindicação.

Opções disponíveis:
OWNERSHIP,
PORTABILITY
Exemplo:

"OWNERSHIP"

Resposta

Reivindicação criada com sucesso.

​
id
string

UUID interno da reivindicação.

Exemplo:

"019c96a0-0c3e-77b5-8321-4807058a67bb"

​
bacenClaimId
string

Identificador BACEN DICT para esta reivindicação.

Exemplo:

"019c96a0-0d16-7184-ad7f-38545eeb671c"

​
key
string

Valor da chave PIX sendo reivindicada.

Exemplo:

"+5561988887777"

​
keyType
string

Tipo de chave PIX.

Exemplo:

"PHONE"

​
type
enum<string>

Tipo de reivindicação.

Opções disponíveis:
OWNERSHIP,
PORTABILITY
Exemplo:

"OWNERSHIP"

​
status
enum<string>

Status atual da reivindicação.

Opções disponíveis:
OPEN,
WAITING_RESOLUTION,
CONFIRMED,
CANCELLED,
COMPLETED
Exemplo:

"OPEN"

​
donorParticipant
string

ISPB do PSP doador.

Exemplo:

"30306294"

​
resolutionPeriodEnd
string<date-time>

Prazo para resposta do doador (D+7 a partir da criação).

Exemplo:

"2024-01-22T10:30:00Z"

​
completionPeriodEnd
string<date-time>

Prazo para conclusão da reivindicação (D+14 a partir da criação).

Exemplo:

"2024-01-29T10:30:00Z"

​
createdAt
string<date-time>

Timestamp de quando a reivindicação foi criada.

Exemplo:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>

Timestamp de quando a reivindicação foi atualizada pela última vez.

Exemplo:

"2024-01-15T10:30:00Z"