Listar mensajes STR

curl --request GET \
  --url https://spb.sandbox.lerian.net/v1/str/messages \
  --header 'Authorization: Bearer <token>'

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

fetch('https://spb.sandbox.lerian.net/v1/str/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://spb.sandbox.lerian.net/v1/str/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://spb.sandbox.lerian.net/v1/str/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))

}

require 'uri'
require 'net/http'

url = URI("https://spb.sandbox.lerian.net/v1/str/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

{
  "correlationId": "<string>",
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "direction": "<string>",
      "messageType": "<string>",
      "nuOp": "<string>",
      "status": "<string>",
      "amount": "<string>",
      "controlNumber": "<string>",
      "mqMessageId": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "strStatus": "<string>"
    }
  ],
  "limit": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

GET

str

messages

Listar mensajes STR

curl --request GET \
  --url https://spb.sandbox.lerian.net/v1/str/messages \
  --header 'Authorization: Bearer <token>'

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

fetch('https://spb.sandbox.lerian.net/v1/str/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://spb.sandbox.lerian.net/v1/str/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://spb.sandbox.lerian.net/v1/str/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))

}

require 'uri'
require 'net/http'

url = URI("https://spb.sandbox.lerian.net/v1/str/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

{
  "correlationId": "<string>",
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "direction": "<string>",
      "messageType": "<string>",
      "nuOp": "<string>",
      "status": "<string>",
      "amount": "<string>",
      "controlNumber": "<string>",
      "mqMessageId": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "strStatus": "<string>"
    }
  ],
  "limit": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

cursor

string

Opaque pagination token from a previous response.

limit

integer<int64>

predeterminado:20

Page size (default 20, max 100).

Rango requerido: 1 <= x <= 100

sort_order

enum<string>

Sort order (default desc, most recent first).

Opciones disponibles:

asc,

desc

message_type

string

Filter by STR message type (e.g. STR0004).

status

enum<string>

Filter by processing status.

Opciones disponibles:

SUBMITTED,

DELIVERED,

CONFIRMED,

REJECTED,

FAILED,

RETURNED,

CANCELED,

RECEIVED

direction

enum<string>

Filter by message direction.

Opciones disponibles:

inbound,

outbound

start_date

string

Lower bound for created_at (RFC3339 or YYYY-MM-DD).

end_date

string

Upper bound for created_at (RFC3339 or YYYY-MM-DD).

Respuesta

correlationId

string

requerido

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

Ejemplo:

"req-7a3f9c2e"

items

object[] | null

requerido

Page of message summaries ordered most-recent-first.

Show child attributes

limit

integer<int64>

requerido

Page size applied to this response (number of items requested).

Ejemplo:

50

nextCursor

string

Opaque cursor for the next page; absent when there are no more results. Presence signals more results, absence signals end-of-list.

Ejemplo:

"eyJjcmVhdGVkQXQiOiIyMDI2LTA1LTA0VDE4OjMwOjAwWiIsImlkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0"

prevCursor

string

Opaque cursor for the previous page; reserved for future bidirectional cursoring, absent today.

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Listar mensajes STR

Autorizaciones

Parámetros de consulta

Respuesta