Skip to main content
POST
/
v1
/
str
/
operations
/
bank-transfers
Create bank transfer operation
curl --request POST \
  --url https://spb.sandbox.lerian.net/v1/str/operations/bank-transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "purposeCode": "<string>",
  "recipient": {
    "ispb": "<string>",
    "account": "<string>",
    "accountType": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "name": "<string>",
    "party": "<string>",
    "paymentAccount": "<string>"
  },
  "sender": {
    "ispb": "<string>",
    "account": "<string>",
    "accountType": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "name": "<string>",
    "party": "<string>",
    "paymentAccount": "<string>"
  },
  "clientReference": "<string>",
  "description": "<string>",
  "metadata": {},
  "scheduledExecutionAt": "2023-11-07T05:31:56Z"
}
'
import requests

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

payload = {
    "amount": "<string>",
    "purposeCode": "<string>",
    "recipient": {
        "ispb": "<string>",
        "account": "<string>",
        "accountType": "<string>",
        "branch": "<string>",
        "document": "<string>",
        "name": "<string>",
        "party": "<string>",
        "paymentAccount": "<string>"
    },
    "sender": {
        "ispb": "<string>",
        "account": "<string>",
        "accountType": "<string>",
        "branch": "<string>",
        "document": "<string>",
        "name": "<string>",
        "party": "<string>",
        "paymentAccount": "<string>"
    },
    "clientReference": "<string>",
    "description": "<string>",
    "metadata": {},
    "scheduledExecutionAt": "2023-11-07T05:31:56Z"
}
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>',
    purposeCode: '<string>',
    recipient: {
      ispb: '<string>',
      account: '<string>',
      accountType: '<string>',
      branch: '<string>',
      document: '<string>',
      name: '<string>',
      party: '<string>',
      paymentAccount: '<string>'
    },
    sender: {
      ispb: '<string>',
      account: '<string>',
      accountType: '<string>',
      branch: '<string>',
      document: '<string>',
      name: '<string>',
      party: '<string>',
      paymentAccount: '<string>'
    },
    clientReference: '<string>',
    description: '<string>',
    metadata: {},
    scheduledExecutionAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://spb.sandbox.lerian.net/v1/str/operations/bank-transfers', 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",
  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>',
    'purposeCode' => '<string>',
    'recipient' => [
        'ispb' => '<string>',
        'account' => '<string>',
        'accountType' => '<string>',
        'branch' => '<string>',
        'document' => '<string>',
        'name' => '<string>',
        'party' => '<string>',
        'paymentAccount' => '<string>'
    ],
    'sender' => [
        'ispb' => '<string>',
        'account' => '<string>',
        'accountType' => '<string>',
        'branch' => '<string>',
        'document' => '<string>',
        'name' => '<string>',
        'party' => '<string>',
        'paymentAccount' => '<string>'
    ],
    'clientReference' => '<string>',
    'description' => '<string>',
    'metadata' => [
        
    ],
    'scheduledExecutionAt' => '2023-11-07T05:31:56Z'
  ]),
  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"

	payload := strings.NewReader("{\n  \"amount\": \"<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    \"party\": \"<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    \"party\": \"<string>\",\n    \"paymentAccount\": \"<string>\"\n  },\n  \"clientReference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {},\n  \"scheduledExecutionAt\": \"2023-11-07T05:31:56Z\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<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    \"party\": \"<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    \"party\": \"<string>\",\n    \"paymentAccount\": \"<string>\"\n  },\n  \"clientReference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {},\n  \"scheduledExecutionAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"purposeCode\": \"<string>\",\n  \"recipient\": {\n    \"ispb\": \"<string>\",\n    \"account\": \"<string>\",\n    \"accountType\": \"<string>\",\n    \"branch\": \"<string>\",\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"party\": \"<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    \"party\": \"<string>\",\n    \"paymentAccount\": \"<string>\"\n  },\n  \"clientReference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {},\n  \"scheduledExecutionAt\": \"2023-11-07T05:31:56Z\"\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; legacy alias X-Idempotency-Key is rejected on this control-plane route).

​
X-Idempotency-Key
string

Idempotency key (legacy alias; rejected on this control-plane route).

​
X-TTL
string

Idempotency key TTL in seconds (overrides the configured default).

Body

application/json
​
amount
string
required

Transfer amount as a decimal string in BRL, minor-unit precision (two decimal places).

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

"150.00"

​
purposeCode
string
required

BACEN STR purpose code (finalidade), exactly 5 digits.

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

"00001"

​
recipient
object
required

Crediting (creditor) participant account receiving the transfer; its party role drives STR-code derivation.

​
sender
object
required

Debiting (debtor) participant account originating the transfer; its party role drives STR-code derivation.

​
clientReference
string

Optional caller-supplied correlation reference echoed back for client-side reconciliation.

Example:

"client-ref-1"

​
description
string

Optional free-text description carried with the operation.

Example:

"Wire transfer for invoice 2026-Q2-A47"

​
metadata
object

Opaque client-side metadata forwarded verbatim to the legacy submit DTO. NOT persisted on the operation intent or sanitized payload; do not include sensitive fields (the legacy pipeline sees the raw value).

​
scheduledExecutionAt
string<date-time>

Optional future settlement instant for a scheduled (agendada) STR transfer (RFC3339). BACEN window: at most 3 business days ahead, settlement hour must be one of 8/9/10/11/12 (Brasília), and at least 15 minutes ahead for same-day. Absent means immediate.

Example:

"2026-06-23T10:00:00Z"

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.