Pular para o conteúdo principal
GET
/
api
/
v1
/
spi
/
messages
Listar o registro de mensagens SPI
curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/spi/messages \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://spi.sandbox.lerian.net/api/v1/spi/messages"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/spi/messages', 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://spi.sandbox.lerian.net/api/v1/spi/messages",
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://spi.sandbox.lerian.net/api/v1/spi/messages"

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://spi.sandbox.lerian.net/api/v1/spi/messages")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/spi/messages")

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": [
    {
      "createdAt": "<string>",
      "direction": "<string>",
      "family": "<string>",
      "messageRecordId": "<string>",
      "messageType": "<string>",
      "payloadHash": "<string>",
      "payloadRetained": true,
      "state": "<string>",
      "businessKey": "<string>",
      "operationId": "<string>",
      "participantIspb": "<string>",
      "receivedAt": "<string>"
    }
  ],
  "limit": 123,
  "correlationId": "<string>",
  "nextCursor": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

family
string

Message family filter (ADMI, CAMT, PACS, PAIN, PIBR, REDA, TRCK, SIGNATURE).

messageType
string

Catalogue message type filter (e.g. pacs.008).

direction
string

Flow filter: INBOUND (recebida), OUTBOUND (enviada), or INTERNAL.

state
string

Lifecycle state filter (e.g. RECEIVED, SUBMITTED, REJECTED, APPLIED).

participantIspb
string

8-digit participant ISPB filter.

businessKey
string

Business correlation key filter.

operationId
string

Operation id filter (correlated rows).

from
string

Inclusive lower bound on created_at (RFC 3339 UTC).

to
string

Inclusive upper bound on created_at (RFC 3339 UTC).

limit
integer<int64>
padrão:50

Page size (default 50, max 200).

Intervalo obrigatório: 1 <= x <= 200
cursor
string

Opaque pagination cursor.

Resposta

OK

items
object[] | null
obrigatório

Message-log rows, newest first.

limit
integer<int64>
obrigatório

Effective page size applied to this response.

correlationId
string

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

nextCursor
string

Opaque cursor for the next page; absent when exhausted.