Crear una operación de liquidación

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

Crear una operación de liquidación

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

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

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.

Cuerpo

application/json

creditorIspb

string

requerido

Creditor (acquirer) ISPB, 8 digits.

Ejemplo:

"29011780"

domicileIfIspb

string

requerido

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

Ejemplo:

"60701190"

dueDate

string

requerido

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

Ejemplo:

"2026-06-15"

externalId

string

requerido

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

Ejemplo:

"acq-ext-2026-06-0001"

installments

integer<int32>

requerido

Total number of installments.

Ejemplo:

3

operationType

string

requerido

Operation type driving the settlement flow.

Ejemplo:

"CREDIT"

participantId

string

requerido

Participant id (UUID) that owns this operation.

Ejemplo:

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

participantRole

string

requerido

Participant role in the settlement.

Ejemplo:

"ACQUIRER"

transactionDate

string

requerido

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

Ejemplo:

"2026-06-15"

value

integer<int64>

requerido

Operation amount in minor units (centavos).

Ejemplo:

150000

arrangementCode

string

Payment arrangement (arranjo) code.

Ejemplo:

"0245"

authorizationCode

string

Card authorization code.

Ejemplo:

"A1B2C3"

brandCode

string

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

Ejemplo:

"VISA"

currency

string

ISO 4217 currency code.

Ejemplo:

"BRL"

establishmentCode

string

Merchant establishment (EC) code.

Ejemplo:

"EC-000123"

installmentNumber

integer<int32>

This installment's sequence number.

Ejemplo:

1

intakeMode

string

Intake mode; defaults to api_jsonl when omitted.

Ejemplo:

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

Ejemplo:

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

pvCode

string

Merchant (PontoVenda) code.

Ejemplo:

"PV-000123"

pvDocument

string

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

Ejemplo:

"12345678000195"

pvName

string

Merchant (PontoVenda) legal/trade name.

Ejemplo:

"Loja Exemplo LTDA"

pvPersonType

string

Merchant person type (natural or legal).

Ejemplo:

"J"

reasonCategory

string

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

Ejemplo:

"4"

settlementIfIspb

string

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

Ejemplo:

"60746948"

Respuesta

Accepted

externalId

string

requerido

Echoed client-side external identifier.

Ejemplo:

"acq-ext-2026-06-0001"

string

requerido

Created operation id (UUID).

Ejemplo:

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

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)

Crear una operación de liquidación

Autorizaciones

Encabezados

Cuerpo

Respuesta