Pular para o conteúdo principal
GET
/
v1
/
claims
/
{claimId}
Consultar reivindicacao
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/claims/{claimId} \
  --header 'Authorization: Bearer <token>'
{
  "claimId": "claim_abc123xyz",
  "key": "+5511987654321",
  "bankId": "12345678"
}

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.

Parâmetros de consulta

​
account_id
string<uuid>

Identificador da conta.

Resposta

Detalhes da reivindicacao recuperados com sucesso

​
claimId
string
obrigatório

Identificador unico da reivindicacao.

Exemplo:

"claim_abc123xyz"

​
key
string
obrigatório

Valor da chave PIX.

Exemplo:

"+5511987654321"

​
bankId
string
obrigatório

Codigo ISPB do banco do proprietario atual da chave.

Exemplo:

"12345678"