Obtener detalle de mensaje STR

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

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

fetch('https://spb.sandbox.lerian.net/v1/str/messages/{nuOp}', 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/{nuOp}",
  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/{nuOp}"

	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/{nuOp}")

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

{
  "message": {
    "createdAt": "2023-11-07T05:31:56Z",
    "direction": "<string>",
    "messageType": "<string>",
    "nuOp": "<string>",
    "amount": "<string>",
    "confirmedAt": "2023-11-07T05:31:56Z",
    "controlNumber": "<string>",
    "description": "<string>",
    "mqMessageId": "<string>",
    "originalControlNumber": "<string>",
    "originalNuOp": "<string>",
    "purposeCode": "<string>",
    "recipientIspb": "<string>",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "senderIspb": "<string>",
    "status": "<string>",
    "strRejectReason": "<string>",
    "strStatus": "<string>",
    "submittedAt": "2023-11-07T05:31:56Z"
  },
  "payload": {},
  "payloadFormat": "<string>",
  "correspondent": {
    "createdAt": "2023-11-07T05:31:56Z",
    "direction": "<string>",
    "messageType": "<string>",
    "nuOp": "<string>",
    "status": "<string>",
    "amount": "<string>",
    "controlNumber": "<string>",
    "strStatus": "<string>"
  },
  "reconstructedXml": "<string>"
}

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

Obtener detalle de mensaje STR

Devuelve el detalle del registro de mensajes para un mensaje STR identificado por su NUOp: el estado y los campos de recibo de BACEN, el payload estructurado, una vista XML reconstruida en lectura (los bytes on-wire persistidos decodificados a XML, etiquetados como reconstruidos; los bytes literales enviados no se retienen por separado) y la contraparte original<->corresponsal resuelta. Busca primero los mensajes de salida y luego los de entrada. El NUOp es un identificador BACEN de 23 dígitos: ISPB[8]+FECHA[8]+SEQ[7].

GET

str

messages

{nuOp}

Obtener detalle de mensaje STR

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

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

fetch('https://spb.sandbox.lerian.net/v1/str/messages/{nuOp}', 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/{nuOp}",
  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/{nuOp}"

	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/{nuOp}")

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

{
  "message": {
    "createdAt": "2023-11-07T05:31:56Z",
    "direction": "<string>",
    "messageType": "<string>",
    "nuOp": "<string>",
    "amount": "<string>",
    "confirmedAt": "2023-11-07T05:31:56Z",
    "controlNumber": "<string>",
    "description": "<string>",
    "mqMessageId": "<string>",
    "originalControlNumber": "<string>",
    "originalNuOp": "<string>",
    "purposeCode": "<string>",
    "recipientIspb": "<string>",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "senderIspb": "<string>",
    "status": "<string>",
    "strRejectReason": "<string>",
    "strStatus": "<string>",
    "submittedAt": "2023-11-07T05:31:56Z"
  },
  "payload": {},
  "payloadFormat": "<string>",
  "correspondent": {
    "createdAt": "2023-11-07T05:31:56Z",
    "direction": "<string>",
    "messageType": "<string>",
    "nuOp": "<string>",
    "status": "<string>",
    "amount": "<string>",
    "controlNumber": "<string>",
    "strStatus": "<string>"
  },
  "reconstructedXml": "<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 ruta

nuOp

string

requerido

Message NUOp (23 digits: ISPB[8]+DATE[8]+SEQ[7]).

Required string length: 23

Pattern: ^[0-9]{23}$

Respuesta

message

object

requerido

The message's status projection (identifiers, lifecycle, BACEN-receipt fields).

Show child attributes

payload

object

requerido

The structured payload_json persisted for this message (parsed STR fields). Always present.

Show child attributes

payloadFormat

string

requerido

How the payload is presented: 'reconstructed' when reconstructedXml carries the persisted on-wire bytes decoded to XML, 'structured' when only the payload fields are available.

Ejemplo:

"reconstructed"

correspondent

object

The resolved original<->correspondent counterpart: for an outbound, the inbound response BACEN sent back; for an inbound, the outbound it answers. Absent when no counterpart has been correlated yet.

Show child attributes

reconstructedXml

string

The persisted on-wire STR payload decoded to UTF-8 XML, labeled reconstructed (the literal sent bytes are not separately retained). Omitted when payloadFormat is 'structured'.

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

Obtener detalle de mensaje STR

Autorizaciones

Parámetros de ruta

Respuesta