Pular para o conteúdo principal
POST
/
v1
/
claims
/
{claimId}
/
conclusion
Concluir reivindicacao
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/claims/{claimId}/conclusion \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "11122233344",
  "accountId": "12345678-1234-1234-1234-123456789012"
}
'
{
  "claimId": "claim_abc123xyz",
  "status": "OPEN"
}

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de caminho

claimId
string
obrigatório

Identificador da reivindicacao.

Corpo

application/json
key
string
obrigatório

Chave PIX para concluir a reivindicacao.

Exemplo:

"11122233344"

accountId
string<uuid>
obrigatório

Identificador da conta do reivindicador.

Exemplo:

"12345678-1234-1234-1234-123456789012"

Resposta

Reivindicacao concluida com sucesso

claimId
string
obrigatório

Identificador unico da reivindicacao.

Exemplo:

"claim_abc123xyz"

status
enum<string>
obrigatório

Status da reivindicacao de propriedade de chave PIX. Valores string representando o estado de uma reivindicacao de portabilidade ou propriedade.

Valores validos:

  • OPEN = Reivindicacao foi iniciada e aguarda acao das partes envolvidas
  • CONFIRMED = Reivindicacao foi confirmada pelo reivindicador
  • COMPLETED = Processo de reivindicacao concluido com sucesso, chave transferida
  • CANCELLED = Reivindicacao foi cancelada pelo reivindicador ou pelo sistema
  • AWAITING_RESOLUTION = Aguardando resolucao ou decisao do proprietario atual da chave
Opções disponíveis:
OPEN,
CONFIRMED,
COMPLETED,
CANCELLED,
AWAITING_RESOLUTION
Exemplo:

"OPEN"