List Claims

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/claims",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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

}

HttpResponse<String> response = Unirest.get("https://plugin-pix-indirect.api.lerian.net/v1/dict/claims")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/claims",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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

}

HttpResponse<String> response = Unirest.get("https://plugin-pix-indirect.api.lerian.net/v1/dict/claims")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer

default:10

Maximum number of items per page.

Required range: 1 <= x <= 100

page

integer

default:1

Page number for pagination.

Required range: x >= 1

type

enum<string>

Filter by claim type.

Available options:

OWNERSHIP,

PORTABILITY

status

enum<string>

Filter by claim status.

Available options:

OPEN,

WAITING_RESOLUTION,

CONFIRMED,

CANCELLED,

COMPLETED

key_value

string

Filter by Pix key value.

sort_order

enum<string>

default:asc

Sort direction: asc or desc.

Available options:

asc,

desc

bacen_claim_id

string

Filter by BACEN claim ID (UUID).

Response

List of claims retrieved successfully.

items

object[]

required

Show child attributes

page

integer

required

Example:

1

limit

integer

required

Example:

10

Create a Claim

Retrieve a Claim

⌘I

Lerian SPB

Lerian SPI

Lerian SILOC

Lerian SLC

Lerian STA

Lerian SISBAJUD

Lerian Consignado

Pix — Direct via JD

Pix — Indirect via BTG

TED — via JD

Payments — via BTG

List Claims

Authorizations

Query Parameters

Response