Skip to main content
POST
/
v1
/
str
/
operations
/
bank-transfers
/
{operationId}
/
returns
Create bank transfer return operation
curl --request POST \
  --url https://spb.sandbox.lerian.net/v1/str/operations/bank-transfers/{operationId}/returns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipientIspb": "<string>",
  "returnCode": "<string>",
  "senderIspb": "<string>",
  "amount": "<string>",
  "description": "<string>",
  "metadata": {}
}
'
import requests

url = "https://spb.sandbox.lerian.net/v1/str/operations/bank-transfers/{operationId}/returns"

payload = {
"recipientIspb": "<string>",
"returnCode": "<string>",
"senderIspb": "<string>",
"amount": "<string>",
"description": "<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({
recipientIspb: '<string>',
returnCode: '<string>',
senderIspb: '<string>',
amount: '<string>',
description: '<string>',
metadata: {}
})
};

fetch('https://spb.sandbox.lerian.net/v1/str/operations/bank-transfers/{operationId}/returns', 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/operations/bank-transfers/{operationId}/returns",
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([
'recipientIspb' => '<string>',
'returnCode' => '<string>',
'senderIspb' => '<string>',
'amount' => '<string>',
'description' => '<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/operations/bank-transfers/{operationId}/returns"

payload := strings.NewReader("{\n \"recipientIspb\": \"<string>\",\n \"returnCode\": \"<string>\",\n \"senderIspb\": \"<string>\",\n \"amount\": \"<string>\",\n \"description\": \"<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/operations/bank-transfers/{operationId}/returns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipientIspb\": \"<string>\",\n \"returnCode\": \"<string>\",\n \"senderIspb\": \"<string>\",\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spb.sandbox.lerian.net/v1/str/operations/bank-transfers/{operationId}/returns")

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 \"recipientIspb\": \"<string>\",\n \"returnCode\": \"<string>\",\n \"senderIspb\": \"<string>\",\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "acceptedAt": "2023-11-07T05:31:56Z",
  "capabilityId": "<string>",
  "correlationId": "<string>",
  "isReplay": true,
  "operationFamily": "<string>",
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "protocolMetadata": {
    "controlNumber": "<string>",
    "nuOp": "<string>"
  }
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Authorization
string

Bearer JWT token.

X-Idempotency
string

Idempotency key (canonical).

X-Idempotency-Key
string

Idempotency key (legacy alias).

X-TTL
string

Idempotency key TTL in seconds.

Path Parameters

operationId
string
required

Original bank-transfer operation UUID.

Body

application/json
recipientIspb
string
required

ISPB of the participant receiving the return, the 8-digit BACEN institution identifier.

Example:

38166

returnCode
string
required

BACEN STR return reason code (devolução) for the reversal.

Example:

"01"

senderIspb
string
required

ISPB of the participant initiating the return, the 8-digit BACEN institution identifier.

Example:

"12345678"

amount
string

Optional partial return amount as a decimal string in BRL, minor-unit precision; defaults to the full original amount when omitted.

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

"50.00"

description
string

Optional free-text description of the return.

Example:

"Wrong account"

metadata
object

Opaque client-side metadata forwarded verbatim to the legacy submit DTO; not persisted on the return intent.

Response

Created

acceptedAt
string<date-time>
required

UTC RFC 3339 timestamp at which the command was accepted.

Example:

"2026-05-06T18:30:00Z"

capabilityId
string
required

STR capability identifier resolved for the accepted operation (e.g. STR0004).

Example:

"STR0004"

correlationId
string
required

Request correlation identifier for tracing the accept across logs and traces.

Example:

"req-7c8b3a2e-9f1d-4a55-9b8e-1e1234567890"

isReplay
boolean
required

True when this response replays a prior idempotent accept rather than creating a new operation.

Example:

false

operationFamily
string
required

Operation family the accepted command belongs to (e.g. bankTransfer).

Example:

"bankTransfer"

operationId
string<uuid>
required

Server-assigned operation aggregate UUID used for subsequent status, return, and cancellation calls.

Example:

"7c8b3a2e-9f1d-4a55-9b8e-1e1234567890"

status
string
required

Current control-plane lifecycle status of the operation; ACCEPTED on initial accept.

Example:

"ACCEPTED"

protocolMetadata
object

Optional SAFE protocol correlation fields; present once the operation is mapped to STR wire identifiers.