Obter uma operação de liquidação

curl --request GET \
  --url https://slc.sandbox.lerian.net/v1/operations/{operationId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://slc.sandbox.lerian.net/v1/operations/{operationId}', 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/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "cancellationTargetOperationId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "createdAt": "2026-06-15T10:50:00Z",
  "currency": "BRL",
  "dueDate": "2026-06-15T00:00:00Z",
  "eslcErrors": [
    "<string>"
  ],
  "externalId": "acq-ext-2026-06-0001",
  "id": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "installmentNumber": 1,
  "installments": 3,
  "intakeMode": "api_jsonl",
  "lastError": "ESLC0029",
  "nuliquid": "202606150000000000001",
  "operationType": "CREDIT",
  "participantId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "participantRole": "ACQUIRER",
  "reasonCategory": "4",
  "settlementIfIspb": "60746948",
  "state": "SETTLED",
  "stuckSince": "2026-06-15T11:00:00Z",
  "transactionDate": "2026-06-15T00:00:00Z",
  "updatedAt": "2026-06-15T13:10:00Z",
  "value": 150000,
  "waitingFor": "nuclea_ack",
  "arrangementCode": "0245",
  "aslcType": "ASLC027",
  "batchId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "creditorIspb": "29011780",
  "domicileIfIspb": "60701190"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

GET

operations

{operationId}

Obter uma operação de liquidação

curl --request GET \
  --url https://slc.sandbox.lerian.net/v1/operations/{operationId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://slc.sandbox.lerian.net/v1/operations/{operationId}', 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/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "cancellationTargetOperationId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "createdAt": "2026-06-15T10:50:00Z",
  "currency": "BRL",
  "dueDate": "2026-06-15T00:00:00Z",
  "eslcErrors": [
    "<string>"
  ],
  "externalId": "acq-ext-2026-06-0001",
  "id": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "installmentNumber": 1,
  "installments": 3,
  "intakeMode": "api_jsonl",
  "lastError": "ESLC0029",
  "nuliquid": "202606150000000000001",
  "operationType": "CREDIT",
  "participantId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "participantRole": "ACQUIRER",
  "reasonCategory": "4",
  "settlementIfIspb": "60746948",
  "state": "SETTLED",
  "stuckSince": "2026-06-15T11:00:00Z",
  "transactionDate": "2026-06-15T00:00:00Z",
  "updatedAt": "2026-06-15T13:10:00Z",
  "value": 150000,
  "waitingFor": "nuclea_ack",
  "arrangementCode": "0245",
  "aslcType": "ASLC027",
  "batchId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "creditorIspb": "29011780",
  "domicileIfIspb": "60701190"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

operationId

string

obrigatório

Settlement operation id (UUID).

Exemplo:

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

Resposta

cancellationTargetOperationId

string | null

obrigatório

Id (UUID) of the operation a CANCELLATION targets; null for every other type.

Exemplo:

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

createdAt

string

obrigatório

Creation timestamp (RFC3339).

Exemplo:

"2026-06-15T10:50:00Z"

currency

string

obrigatório

ISO 4217 currency code.

Exemplo:

"BRL"

dueDate

string | null

obrigatório

Settlement due date (RFC3339); null when not set.

Exemplo:

"2026-06-15T00:00:00Z"

eslcErrors

string[] | null

obrigatório

Recorded Núclea business error codes (empty array when none).

externalId

string

obrigatório

Client-side external identifier.

Exemplo:

"acq-ext-2026-06-0001"

string

obrigatório

Operation id (UUID).

Exemplo:

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

installmentNumber

integer<int32>

obrigatório

This installment's sequence number.

Exemplo:

1

installments

integer<int32>

obrigatório

Total number of installments.

Exemplo:

3

intakeMode

string

obrigatório

Intake mode the operation was received through.

Exemplo:

"api_jsonl"

lastError

string | null

obrigatório

Most recent recorded Núclea business error code; null when none.

Exemplo:

"ESLC0029"

nuliquid

string | null

obrigatório

Núclea-assigned NUliquid (21 positions); null until assigned.

Exemplo:

"202606150000000000001"

operationType

string

obrigatório

Operation type.

Exemplo:

"CREDIT"

participantId

string

obrigatório

Owning participant id (UUID).

Exemplo:

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

participantRole

string

obrigatório

Participant role in the settlement.

Exemplo:

"ACQUIRER"

reasonCategory

string | null

obrigatório

Numeric MotvCanc cancellation reason ('1'..'4'); null unless a CANCELLATION.

Exemplo:

"4"

settlementIfIspb

string | null

obrigatório

Settlement FI ISPB, 8 digits; null when not set.

Exemplo:

"60746948"

state

string

obrigatório

Lifecycle state.

Exemplo:

"SETTLED"

stuckSince

string | null

obrigatório

Timestamp since the operation has been internally stuck (RFC3339); null when not stuck.

Exemplo:

"2026-06-15T11:00:00Z"

transactionDate

string

obrigatório

Business transaction date (RFC3339).

Exemplo:

"2026-06-15T00:00:00Z"

updatedAt

string

obrigatório

Last-update timestamp (RFC3339).

Exemplo:

"2026-06-15T13:10:00Z"

value

integer<int64>

obrigatório

Operation amount in minor units (centavos).

Exemplo:

150000

waitingFor

enum<string> | null

obrigatório

What the operation is waiting on, and therefore which recovery verb applies. transport/nuclea_ack/if_confirmation are external waits (reconcile or wait). parked means an outbound transmit claim is held because the attempt budget was exhausted and nothing reached Núclea: recover with POST /v1/connectivity/unpark. in_flight means the file IS at Núclea and the local transition failed: reconcile with Núclea, then POST /v1/operations/{operationId}/advance, and NEVER un-park it. null names NO verb: it means no external dependency is named for this state — the operation is terminal, or the wait is internal (CREATED/ACCEPTED, where advance/requeue applies), or it awaits a counterpart this vocabulary does not name yet (CONFIRMED awaits the funding ack plus the Núclea cycle close; SETTLED awaits the D+1 return file). Pair a null with state before choosing an action.

Opções disponíveis:

transport,

nuclea_ack,

if_confirmation,

parked,

in_flight,

null

Exemplo:

"nuclea_ack"

arrangementCode

string

Payment arrangement (arranjo) code.

Exemplo:

"0245"

aslcType

string

ASLC message type materialized for this operation.

Exemplo:

"ASLC027"

batchId

string

Batch id when created via the NDJSON batch endpoint.

Exemplo:

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

creditorIspb

string

Creditor (acquirer) ISPB, 8 digits.

Exemplo:

"29011780"

domicileIfIspb

string

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

Exemplo:

"60701190"

Pix — Lerian SPI (mensageria nativa)

Pix — JD (interface, direto)

Pix — BTG (interface, indireto)

TED — Lerian SPB (mensageria nativa)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (mensageria nativa)

Lerian SLC (mensageria nativa)

Lerian STA (mensageria nativa)

Lerian SISBAJUD (mensageria nativa)

Lerian Consignado — Dataprev

Obter uma operação de liquidação

Autorizações

Parâmetros de caminho

Resposta