Create a settlement operation

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "creditorIspb": "<string>",
  "domicileIfIspb": "<string>",
  "dueDate": "<string>",
  "externalId": "<string>",
  "installments": 123,
  "operationType": "<string>",
  "participantId": "<string>",
  "participantRole": "<string>",
  "transactionDate": "<string>",
  "value": 123,
  "arrangementCode": "<string>",
  "authorizationCode": "<string>",
  "brandCode": "<string>",
  "currency": "<string>",
  "establishmentCode": "<string>",
  "installmentNumber": 123,
  "intakeMode": "<string>",
  "metadata": {},
  "originalOperationId": "<string>",
  "pvCode": "<string>",
  "pvDocument": "<string>",
  "pvName": "<string>",
  "pvPersonType": "<string>",
  "reasonCategory": "<string>",
  "settlementIfIspb": "<string>"
}
'

import requests

url = "https://slc.sandbox.lerian.net/v1/operations"

payload = {
    "creditorIspb": "<string>",
    "domicileIfIspb": "<string>",
    "dueDate": "<string>",
    "externalId": "<string>",
    "installments": 123,
    "operationType": "<string>",
    "participantId": "<string>",
    "participantRole": "<string>",
    "transactionDate": "<string>",
    "value": 123,
    "arrangementCode": "<string>",
    "authorizationCode": "<string>",
    "brandCode": "<string>",
    "currency": "<string>",
    "establishmentCode": "<string>",
    "installmentNumber": 123,
    "intakeMode": "<string>",
    "metadata": {},
    "originalOperationId": "<string>",
    "pvCode": "<string>",
    "pvDocument": "<string>",
    "pvName": "<string>",
    "pvPersonType": "<string>",
    "reasonCategory": "<string>",
    "settlementIfIspb": "<string>"
}
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({
    creditorIspb: '<string>',
    domicileIfIspb: '<string>',
    dueDate: '<string>',
    externalId: '<string>',
    installments: 123,
    operationType: '<string>',
    participantId: '<string>',
    participantRole: '<string>',
    transactionDate: '<string>',
    value: 123,
    arrangementCode: '<string>',
    authorizationCode: '<string>',
    brandCode: '<string>',
    currency: '<string>',
    establishmentCode: '<string>',
    installmentNumber: 123,
    intakeMode: '<string>',
    metadata: {},
    originalOperationId: '<string>',
    pvCode: '<string>',
    pvDocument: '<string>',
    pvName: '<string>',
    pvPersonType: '<string>',
    reasonCategory: '<string>',
    settlementIfIspb: '<string>'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/operations', 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://slc.sandbox.lerian.net/v1/operations",
  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([
    'creditorIspb' => '<string>',
    'domicileIfIspb' => '<string>',
    'dueDate' => '<string>',
    'externalId' => '<string>',
    'installments' => 123,
    'operationType' => '<string>',
    'participantId' => '<string>',
    'participantRole' => '<string>',
    'transactionDate' => '<string>',
    'value' => 123,
    'arrangementCode' => '<string>',
    'authorizationCode' => '<string>',
    'brandCode' => '<string>',
    'currency' => '<string>',
    'establishmentCode' => '<string>',
    'installmentNumber' => 123,
    'intakeMode' => '<string>',
    'metadata' => [
        
    ],
    'originalOperationId' => '<string>',
    'pvCode' => '<string>',
    'pvDocument' => '<string>',
    'pvName' => '<string>',
    'pvPersonType' => '<string>',
    'reasonCategory' => '<string>',
    'settlementIfIspb' => '<string>'
  ]),
  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://slc.sandbox.lerian.net/v1/operations"

	payload := strings.NewReader("{\n  \"creditorIspb\": \"<string>\",\n  \"domicileIfIspb\": \"<string>\",\n  \"dueDate\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"installments\": 123,\n  \"operationType\": \"<string>\",\n  \"participantId\": \"<string>\",\n  \"participantRole\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"value\": 123,\n  \"arrangementCode\": \"<string>\",\n  \"authorizationCode\": \"<string>\",\n  \"brandCode\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"establishmentCode\": \"<string>\",\n  \"installmentNumber\": 123,\n  \"intakeMode\": \"<string>\",\n  \"metadata\": {},\n  \"originalOperationId\": \"<string>\",\n  \"pvCode\": \"<string>\",\n  \"pvDocument\": \"<string>\",\n  \"pvName\": \"<string>\",\n  \"pvPersonType\": \"<string>\",\n  \"reasonCategory\": \"<string>\",\n  \"settlementIfIspb\": \"<string>\"\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://slc.sandbox.lerian.net/v1/operations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"creditorIspb\": \"<string>\",\n  \"domicileIfIspb\": \"<string>\",\n  \"dueDate\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"installments\": 123,\n  \"operationType\": \"<string>\",\n  \"participantId\": \"<string>\",\n  \"participantRole\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"value\": 123,\n  \"arrangementCode\": \"<string>\",\n  \"authorizationCode\": \"<string>\",\n  \"brandCode\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"establishmentCode\": \"<string>\",\n  \"installmentNumber\": 123,\n  \"intakeMode\": \"<string>\",\n  \"metadata\": {},\n  \"originalOperationId\": \"<string>\",\n  \"pvCode\": \"<string>\",\n  \"pvDocument\": \"<string>\",\n  \"pvName\": \"<string>\",\n  \"pvPersonType\": \"<string>\",\n  \"reasonCategory\": \"<string>\",\n  \"settlementIfIspb\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/v1/operations")

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  \"creditorIspb\": \"<string>\",\n  \"domicileIfIspb\": \"<string>\",\n  \"dueDate\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"installments\": 123,\n  \"operationType\": \"<string>\",\n  \"participantId\": \"<string>\",\n  \"participantRole\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"value\": 123,\n  \"arrangementCode\": \"<string>\",\n  \"authorizationCode\": \"<string>\",\n  \"brandCode\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"establishmentCode\": \"<string>\",\n  \"installmentNumber\": 123,\n  \"intakeMode\": \"<string>\",\n  \"metadata\": {},\n  \"originalOperationId\": \"<string>\",\n  \"pvCode\": \"<string>\",\n  \"pvDocument\": \"<string>\",\n  \"pvName\": \"<string>\",\n  \"pvPersonType\": \"<string>\",\n  \"reasonCategory\": \"<string>\",\n  \"settlementIfIspb\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "externalId": "<string>",
  "id": "<string>",
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  },
  "state": "<string>"
}

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

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

POST

operations

Create a settlement operation

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "creditorIspb": "<string>",
  "domicileIfIspb": "<string>",
  "dueDate": "<string>",
  "externalId": "<string>",
  "installments": 123,
  "operationType": "<string>",
  "participantId": "<string>",
  "participantRole": "<string>",
  "transactionDate": "<string>",
  "value": 123,
  "arrangementCode": "<string>",
  "authorizationCode": "<string>",
  "brandCode": "<string>",
  "currency": "<string>",
  "establishmentCode": "<string>",
  "installmentNumber": 123,
  "intakeMode": "<string>",
  "metadata": {},
  "originalOperationId": "<string>",
  "pvCode": "<string>",
  "pvDocument": "<string>",
  "pvName": "<string>",
  "pvPersonType": "<string>",
  "reasonCategory": "<string>",
  "settlementIfIspb": "<string>"
}
'

import requests

url = "https://slc.sandbox.lerian.net/v1/operations"

payload = {
    "creditorIspb": "<string>",
    "domicileIfIspb": "<string>",
    "dueDate": "<string>",
    "externalId": "<string>",
    "installments": 123,
    "operationType": "<string>",
    "participantId": "<string>",
    "participantRole": "<string>",
    "transactionDate": "<string>",
    "value": 123,
    "arrangementCode": "<string>",
    "authorizationCode": "<string>",
    "brandCode": "<string>",
    "currency": "<string>",
    "establishmentCode": "<string>",
    "installmentNumber": 123,
    "intakeMode": "<string>",
    "metadata": {},
    "originalOperationId": "<string>",
    "pvCode": "<string>",
    "pvDocument": "<string>",
    "pvName": "<string>",
    "pvPersonType": "<string>",
    "reasonCategory": "<string>",
    "settlementIfIspb": "<string>"
}
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({
    creditorIspb: '<string>',
    domicileIfIspb: '<string>',
    dueDate: '<string>',
    externalId: '<string>',
    installments: 123,
    operationType: '<string>',
    participantId: '<string>',
    participantRole: '<string>',
    transactionDate: '<string>',
    value: 123,
    arrangementCode: '<string>',
    authorizationCode: '<string>',
    brandCode: '<string>',
    currency: '<string>',
    establishmentCode: '<string>',
    installmentNumber: 123,
    intakeMode: '<string>',
    metadata: {},
    originalOperationId: '<string>',
    pvCode: '<string>',
    pvDocument: '<string>',
    pvName: '<string>',
    pvPersonType: '<string>',
    reasonCategory: '<string>',
    settlementIfIspb: '<string>'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/operations', 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://slc.sandbox.lerian.net/v1/operations",
  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([
    'creditorIspb' => '<string>',
    'domicileIfIspb' => '<string>',
    'dueDate' => '<string>',
    'externalId' => '<string>',
    'installments' => 123,
    'operationType' => '<string>',
    'participantId' => '<string>',
    'participantRole' => '<string>',
    'transactionDate' => '<string>',
    'value' => 123,
    'arrangementCode' => '<string>',
    'authorizationCode' => '<string>',
    'brandCode' => '<string>',
    'currency' => '<string>',
    'establishmentCode' => '<string>',
    'installmentNumber' => 123,
    'intakeMode' => '<string>',
    'metadata' => [
        
    ],
    'originalOperationId' => '<string>',
    'pvCode' => '<string>',
    'pvDocument' => '<string>',
    'pvName' => '<string>',
    'pvPersonType' => '<string>',
    'reasonCategory' => '<string>',
    'settlementIfIspb' => '<string>'
  ]),
  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://slc.sandbox.lerian.net/v1/operations"

	payload := strings.NewReader("{\n  \"creditorIspb\": \"<string>\",\n  \"domicileIfIspb\": \"<string>\",\n  \"dueDate\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"installments\": 123,\n  \"operationType\": \"<string>\",\n  \"participantId\": \"<string>\",\n  \"participantRole\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"value\": 123,\n  \"arrangementCode\": \"<string>\",\n  \"authorizationCode\": \"<string>\",\n  \"brandCode\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"establishmentCode\": \"<string>\",\n  \"installmentNumber\": 123,\n  \"intakeMode\": \"<string>\",\n  \"metadata\": {},\n  \"originalOperationId\": \"<string>\",\n  \"pvCode\": \"<string>\",\n  \"pvDocument\": \"<string>\",\n  \"pvName\": \"<string>\",\n  \"pvPersonType\": \"<string>\",\n  \"reasonCategory\": \"<string>\",\n  \"settlementIfIspb\": \"<string>\"\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://slc.sandbox.lerian.net/v1/operations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"creditorIspb\": \"<string>\",\n  \"domicileIfIspb\": \"<string>\",\n  \"dueDate\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"installments\": 123,\n  \"operationType\": \"<string>\",\n  \"participantId\": \"<string>\",\n  \"participantRole\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"value\": 123,\n  \"arrangementCode\": \"<string>\",\n  \"authorizationCode\": \"<string>\",\n  \"brandCode\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"establishmentCode\": \"<string>\",\n  \"installmentNumber\": 123,\n  \"intakeMode\": \"<string>\",\n  \"metadata\": {},\n  \"originalOperationId\": \"<string>\",\n  \"pvCode\": \"<string>\",\n  \"pvDocument\": \"<string>\",\n  \"pvName\": \"<string>\",\n  \"pvPersonType\": \"<string>\",\n  \"reasonCategory\": \"<string>\",\n  \"settlementIfIspb\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/v1/operations")

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  \"creditorIspb\": \"<string>\",\n  \"domicileIfIspb\": \"<string>\",\n  \"dueDate\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"installments\": 123,\n  \"operationType\": \"<string>\",\n  \"participantId\": \"<string>\",\n  \"participantRole\": \"<string>\",\n  \"transactionDate\": \"<string>\",\n  \"value\": 123,\n  \"arrangementCode\": \"<string>\",\n  \"authorizationCode\": \"<string>\",\n  \"brandCode\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"establishmentCode\": \"<string>\",\n  \"installmentNumber\": 123,\n  \"intakeMode\": \"<string>\",\n  \"metadata\": {},\n  \"originalOperationId\": \"<string>\",\n  \"pvCode\": \"<string>\",\n  \"pvDocument\": \"<string>\",\n  \"pvName\": \"<string>\",\n  \"pvPersonType\": \"<string>\",\n  \"reasonCategory\": \"<string>\",\n  \"settlementIfIspb\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "externalId": "<string>",
  "id": "<string>",
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  },
  "state": "<string>"
}

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

{
  "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

Idempotency-Key

string

Idempotency key for safe retries; a replay returns the stored response.

X-Request-Id

string

Optional client request id echoed back in meta.requestId.

Body

application/json

creditorIspb

string

required

Creditor (acquirer) ISPB, 8 digits.

Example:

"29011780"

domicileIfIspb

string

required

Domicile FI ISPB (bank where the merchant receives funds), 8 digits.

Example:

"60701190"

dueDate

string

required

Settlement due date, date-only (YYYY-MM-DD).

Example:

"2026-06-15"

externalId

string

required

Client-side unique identifier for the operation (idempotent external reference).

Example:

"acq-ext-2026-06-0001"

installments

integer<int32>

required

Total number of installments.

Example:

3

operationType

string

required

Operation type driving the settlement flow.

Example:

"CREDIT"

participantId

string

required

Participant id (UUID) that owns this operation.

Example:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

participantRole

string

required

Participant role in the settlement.

Example:

"ACQUIRER"

transactionDate

string

required

Business transaction date, date-only (YYYY-MM-DD).

Example:

"2026-06-15"

value

integer<int64>

required

Operation amount in minor units (centavos).

Example:

150000

arrangementCode

string

Payment arrangement (arranjo) code.

Example:

"0245"

authorizationCode

string

Card authorization code.

Example:

"A1B2C3"

brandCode

string

Card brand code (catalog: Visa/Master/Elo).

Example:

"VISA"

currency

string

ISO 4217 currency code.

Example:

"BRL"

establishmentCode

string

Merchant establishment (EC) code.

Example:

"EC-000123"

installmentNumber

integer<int32>

This installment's sequence number.

Example:

1

intakeMode

string

Intake mode; defaults to api_jsonl when omitted.

Example:

"api_jsonl"

metadata

object

Free-form client metadata attached to the operation.

Show child attributes

originalOperationId

string

Id (UUID) of the operation a CANCELLATION targets.

Example:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

pvCode

string

Merchant (PontoVenda) code.

Example:

"PV-000123"

pvDocument

string

Merchant CPF/CNPJ document (regulated PII; never logged in the clear).

Example:

"12345678000195"

pvName

string

Merchant (PontoVenda) legal/trade name.

Example:

"Loja Exemplo LTDA"

pvPersonType

string

Merchant person type (natural or legal).

Example:

"J"

reasonCategory

string

Numeric MotvCanc cancellation reason ('1'..'4'); required for operationType=CANCELLATION.

Example:

"4"

settlementIfIspb

string

Settlement FI ISPB (moves reserves at the STR), 8 digits; optional.

Example:

"60746948"

Response

Accepted

externalId

string

required

Echoed client-side external identifier.

Example:

"acq-ext-2026-06-0001"

string

required

Created operation id (UUID).

Example:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Create a settlement operation

Authorizations

Headers

Body

Response