List PIX key claims

curl --request GET \
  --url https://api.example.com/v1/claims \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/v1/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://api.example.com/v1/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "claims": [
    {
      "claimId": "claim-123",
      "ispb": "12345678",
      "key": "11122233300"
    }
  ],
  "data": [
    {
      "claimId": "claim-123",
      "ispb": "12345678",
      "key": "11122233300",
      "status": 1,
      "statusDescription": "ACTIVE",
      "type": 0
    }
  ]
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

List PIX key claims

Two different listings behind one route, selected by the status query parameter.

With no status (the default) it returns DICT’s §8.2.13 claim listing for the PARTICIPANT, not for the account: account_id only resolves the caller’s ISPB, and the request body carries that ISPB and nothing else, so every claim DICT associates with the institution comes back - including claims that belong to OTHER accounts under the same ISPB. There is no filter, no paging and no local sort. Two consequences follow from the omitted fields: §8.2.13 declares that an omitted stReivindicacao defaults to situation 1 (Aguardando Resolução), so claims in other situations may not appear; and each row is only key, ispb and claimId, with no state, because DICT’s situation value cannot be projected onto this API’s status enum without losing cases.

With status=processing it answers something else entirely - the in-flight claims of §8.2.08, filtered to the caller’s own account number, projected onto the key-entry shape and returned under data instead of claims. The projected status is 5 (you are waiting for the holder), 6 (you hold the key and must decide) or 7 (the holder gave it away; conclude it). Cancelled and completed claims are dropped, and only the FIRST §8.2.08 page (100 rows) is read. Any other status value falls through to the default branch. An account the CRM cannot resolve is 404 PIX-2016.

GET

claims

List PIX key claims

curl --request GET \
  --url https://api.example.com/v1/claims \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/v1/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://api.example.com/v1/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "claims": [
    {
      "claimId": "claim-123",
      "ispb": "12345678",
      "key": "11122233300"
    }
  ],
  "data": [
    {
      "claimId": "claim-123",
      "ispb": "12345678",
      "key": "11122233300",
      "status": 1,
      "statusDescription": "ACTIVE",
      "type": 0
    }
  ]
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

account_id

string

requerido

The CRM account id whose claims to list.

Ejemplo:

"acc-123"

status

string

Set to 'processing' to list in-flight claims as key entries instead of claims.

Ejemplo:

"processing"

Respuesta

claims

object[] | null

The list of claims (default branch).

Show child attributes

data

object[] | null

The in-flight claims as key entries (?status=processing branch).

Show child attributes

Asientos

Reclamaciones

Bancos

Indirectos

Transacciones

Límites

Códigos QR

Devoluciones

PIX Automatico

MED Infracciones

MED Devoluciones

MED Marcadores de Fraude

MED Recuperaciones

MED Crédito Entrante

Webhooks

Manejo de errores

Eventos

List PIX key claims

Autorizaciones

Parámetros de consulta

Respuesta