Saltar al contenido principal
POST
/
v1
/
str
/
messages
/
compose
Componer y enviar un mensaje STR curado
curl --request POST \
  --url https://spb.sandbox.lerian.net/v1/str/messages/compose \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "capabilityId": "<string>",
  "purposeCode": "<string>",
  "recipient": {
    "ispb": "<string>",
    "account": "<string>",
    "accountType": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "name": "<string>",
    "paymentAccount": "<string>"
  },
  "sender": {
    "ispb": "<string>",
    "account": "<string>",
    "accountType": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "name": "<string>",
    "paymentAccount": "<string>"
  },
  "description": "<string>",
  "finlddCli": "<string>",
  "metadata": {}
}
'
import requests

url = "https://spb.sandbox.lerian.net/v1/str/messages/compose"

payload = {
"amount": "<string>",
"capabilityId": "<string>",
"purposeCode": "<string>",
"recipient": {
"ispb": "<string>",
"account": "<string>",
"accountType": "<string>",
"branch": "<string>",
"document": "<string>",
"name": "<string>",
"paymentAccount": "<string>"
},
"sender": {
"ispb": "<string>",
"account": "<string>",
"accountType": "<string>",
"branch": "<string>",
"document": "<string>",
"name": "<string>",
"paymentAccount": "<string>"
},
"description": "<string>",
"finlddCli": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
capabilityId: '<string>',
purposeCode: '<string>',
recipient: {
ispb: '<string>',
account: '<string>',
accountType: '<string>',
branch: '<string>',
document: '<string>',
name: '<string>',
paymentAccount: '<string>'
},
sender: {
ispb: '<string>',
account: '<string>',
accountType: '<string>',
branch: '<string>',
document: '<string>',
name: '<string>',
paymentAccount: '<string>'
},
description: '<string>',
finlddCli: '<string>',
metadata: {}
})
};

fetch('https://spb.sandbox.lerian.net/v1/str/messages/compose', 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/compose",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '<string>',
'capabilityId' => '<string>',
'purposeCode' => '<string>',
'recipient' => [
'ispb' => '<string>',
'account' => '<string>',
'accountType' => '<string>',
'branch' => '<string>',
'document' => '<string>',
'name' => '<string>',
'paymentAccount' => '<string>'
],
'sender' => [
'ispb' => '<string>',
'account' => '<string>',
'accountType' => '<string>',
'branch' => '<string>',
'document' => '<string>',
'name' => '<string>',
'paymentAccount' => '<string>'
],
'description' => '<string>',
'finlddCli' => '<string>',
'metadata' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://spb.sandbox.lerian.net/v1/str/messages/compose"

payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"capabilityId\": \"<string>\",\n \"purposeCode\": \"<string>\",\n \"recipient\": {\n \"ispb\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"branch\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentAccount\": \"<string>\"\n },\n \"sender\": {\n \"ispb\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"branch\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentAccount\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"finlddCli\": \"<string>\",\n \"metadata\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://spb.sandbox.lerian.net/v1/str/messages/compose")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"capabilityId\": \"<string>\",\n \"purposeCode\": \"<string>\",\n \"recipient\": {\n \"ispb\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"branch\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentAccount\": \"<string>\"\n },\n \"sender\": {\n \"ispb\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"branch\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentAccount\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"finlddCli\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spb.sandbox.lerian.net/v1/str/messages/compose")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"capabilityId\": \"<string>\",\n \"purposeCode\": \"<string>\",\n \"recipient\": {\n \"ispb\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"branch\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentAccount\": \"<string>\"\n },\n \"sender\": {\n \"ispb\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"branch\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentAccount\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"finlddCli\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "controlNumber": "<string>",
  "correlationId": "<string>",
  "messageId": "<string>",
  "nuOp": "<string>",
  "status": "<string>",
  "emissionApprovalId": "<string>",
  "requiredSignatures": 123
}
{
"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.

Encabezados

Authorization
string

Bearer JWT token (the maker subject is derived from it for the alçada gate).

X-Idempotency
string

Idempotency key (canonical; legacy alias X-Idempotency-Key).

X-Idempotency-Key
string

Idempotency key (legacy alias).

X-TTL
string

Idempotency key TTL in seconds.

Cuerpo

application/json
amount
string
requerido

Transfer amount as a decimal string in BRL, minor-unit precision (two decimal places). Forwarded VERBATIM into the submit DTO and the alçada gate — Lerian SPB performs NO arithmetic on it.

Pattern: ^[0-9]+(\.[0-9]+)?$
Ejemplo:

"150000.00"

capabilityId
string
requerido

STR capability code to compose. Must resolve in the catalog, be PUBLICLY_SUBMITTABLE, and be in the compose allowlist (STR0004/STR0005/STR0006/STR0007/STR0008/STR0053).

Ejemplo:

"STR0008"

purposeCode
string
requerido

BACEN STR purpose code (finalidade), exactly 5 digits. When 99999 (Outros) a description is mandatory (RSTR0034).

Pattern: ^[0-9]{5}$
Ejemplo:

"00001"

recipient
object
requerido

Crediting (creditor) participant account receiving the transfer.

sender
object
requerido

Debiting (debtor) participant account originating the transfer.

description
string

Optional free-text description; mandatory when purposeCode or finlddCli is 99999 (RSTR0034). Serialized into the STR Hist element.

Ejemplo:

"Wire transfer for invoice 2026-Q2-A47"

finlddCli
string

Optional client-level purpose code (5 digits) carried on STR0004/STR0008. When 99999 the description is required (RSTR0034).

Pattern: ^[0-9]{5}$
Ejemplo:

"00001"

metadata
object

Opaque client-side metadata forwarded verbatim to the submit DTO (NOT sent to BACEN). Do not include sensitive fields.

Respuesta

Accepted

controlNumber
string
requerido

14-digit STR control number identifying the message on the SPB network.

Ejemplo:

"20260621000001"

correlationId
string
requerido

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

Ejemplo:

"req-7a3f9c2e"

messageId
string
requerido

Internal outbound-message id assigned at persistence time; the key for the approval queue when parked.

Ejemplo:

"6f2c8a1e-..."

nuOp
string
requerido

23-digit STR operation number stamped on the composed message (protocol correlation).

Ejemplo:

"12345678202606210000001"

status
string
requerido

Emission status: SUBMITTED (dispatched / liquidatable) or PENDING_APPROVAL (parked awaiting maker-checker quorum).

Ejemplo:

"PENDING_APPROVAL"

emissionApprovalId
string

Set ONLY when the emission parked: the maker-checker queue id (equal to messageId). Poll GET /v1/str/emission-approvals to track it. Empty when SUBMITTED immediately.

Ejemplo:

"6f2c8a1e-..."

requiredSignatures
integer<int64>

N-of-M distinct-actor quorum the parked emission must collect (the alçada band requirement). Omitted/0 when SUBMITTED immediately.

Ejemplo:

2