List Claims

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/claims \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "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"
    }
  ],
  "page": 1,
  "limit": 10
}

GET

dict

claims

List Claims

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/claims \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "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"
    }
  ],
  "page": 1,
  "limit": 10
}

Autorizações

Authorization

string

header

obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

limit

integer

padrão:10

Maximum number of items per page.

Intervalo obrigatório: 1 <= x <= 100

page

integer

padrão:1

Page number for pagination.

Intervalo obrigatório: x >= 1

type

enum<string>

Filter by claim type.

Opções disponíveis:

OWNERSHIP,

PORTABILITY

status

enum<string>

Filter by claim status.

Opções disponíveis:

OPEN,

WAITING_RESOLUTION,

CONFIRMED,

CANCELLED,

COMPLETED

key_value

string

Filter by Pix key value.

sort_order

enum<string>

padrão:asc

Sort direction: asc or desc.

Opções disponíveis:

asc,

desc

bacen_claim_id

string

Filter by BACEN claim ID (UUID).

Resposta

List of claims retrieved successfully.

items

object[]

obrigatório

Show child attributes

page

integer

obrigatório

Exemplo:

1

limit

integer

obrigatório

Exemplo:

10

API de DICT

API de Reivindicações

MED · Infrações

MED · Marcadores de fraude

MED · Solicitações de devolução

MED · Estatísticas

API de Transações

API de QR Codes

API de Cobranças

API de Recuperação de Fundos

API de Conciliação

API de Pix Automático

API de Agendamentos

API de Relatórios de Transação

API de Webhooks

Tratamento de erros

List Claims

Autorizações

Parâmetros de consulta

Resposta