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": "29011780",
  "domicileIfIspb": "60701190",
  "dueDate": "2026-06-15",
  "externalId": "acq-ext-2026-06-0001",
  "installments": 3,
  "operationType": "CREDIT",
  "participantId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "participantRole": "ACQUIRER",
  "transactionDate": "2026-06-15",
  "value": 150000,
  "arrangementCode": "0245",
  "authorizationCode": "A1B2C3",
  "brandCode": "VISA",
  "currency": "BRL",
  "establishmentCode": "EC-000123",
  "installmentNumber": 1,
  "intakeMode": "api_jsonl",
  "metadata": {},
  "originalOperationId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "pvCode": "PV-000123",
  "pvDocument": "12345678000195",
  "pvName": "Loja Exemplo LTDA",
  "pvPersonType": "J",
  "reasonCategory": "4",
  "settlementIfIspb": "60746948"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"creditorIspb\": \"29011780\",\n  \"domicileIfIspb\": \"60701190\",\n  \"dueDate\": \"2026-06-15\",\n  \"externalId\": \"acq-ext-2026-06-0001\",\n  \"installments\": 3,\n  \"operationType\": \"CREDIT\",\n  \"participantId\": \"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e\",\n  \"participantRole\": \"ACQUIRER\",\n  \"transactionDate\": \"2026-06-15\",\n  \"value\": 150000,\n  \"arrangementCode\": \"0245\",\n  \"authorizationCode\": \"A1B2C3\",\n  \"brandCode\": \"VISA\",\n  \"currency\": \"BRL\",\n  \"establishmentCode\": \"EC-000123\",\n  \"installmentNumber\": 1,\n  \"intakeMode\": \"api_jsonl\",\n  \"metadata\": {},\n  \"originalOperationId\": \"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e\",\n  \"pvCode\": \"PV-000123\",\n  \"pvDocument\": \"12345678000195\",\n  \"pvName\": \"Loja Exemplo LTDA\",\n  \"pvPersonType\": \"J\",\n  \"reasonCategory\": \"4\",\n  \"settlementIfIspb\": \"60746948\"\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    creditorIspb: '29011780',
    domicileIfIspb: '60701190',
    dueDate: '2026-06-15',
    externalId: 'acq-ext-2026-06-0001',
    installments: 3,
    operationType: 'CREDIT',
    participantId: '018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e',
    participantRole: 'ACQUIRER',
    transactionDate: '2026-06-15',
    value: 150000,
    arrangementCode: '0245',
    authorizationCode: 'A1B2C3',
    brandCode: 'VISA',
    currency: 'BRL',
    establishmentCode: 'EC-000123',
    installmentNumber: 1,
    intakeMode: 'api_jsonl',
    metadata: {},
    originalOperationId: '018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e',
    pvCode: 'PV-000123',
    pvDocument: '12345678000195',
    pvName: 'Loja Exemplo LTDA',
    pvPersonType: 'J',
    reasonCategory: '4',
    settlementIfIspb: '60746948'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

payload = {
    "creditorIspb": "29011780",
    "domicileIfIspb": "60701190",
    "dueDate": "2026-06-15",
    "externalId": "acq-ext-2026-06-0001",
    "installments": 3,
    "operationType": "CREDIT",
    "participantId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
    "participantRole": "ACQUIRER",
    "transactionDate": "2026-06-15",
    "value": 150000,
    "arrangementCode": "0245",
    "authorizationCode": "A1B2C3",
    "brandCode": "VISA",
    "currency": "BRL",
    "establishmentCode": "EC-000123",
    "installmentNumber": 1,
    "intakeMode": "api_jsonl",
    "metadata": {},
    "originalOperationId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
    "pvCode": "PV-000123",
    "pvDocument": "12345678000195",
    "pvName": "Loja Exemplo LTDA",
    "pvPersonType": "J",
    "reasonCategory": "4",
    "settlementIfIspb": "60746948"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "externalId": "acq-ext-2026-06-0001",
  "id": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "meta": {
    "requestId": "req-2026-06-15-abc123",
    "timestamp": "2026-06-15T10:50:00Z"
  },
  "state": "CREATED"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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": "29011780",
  "domicileIfIspb": "60701190",
  "dueDate": "2026-06-15",
  "externalId": "acq-ext-2026-06-0001",
  "installments": 3,
  "operationType": "CREDIT",
  "participantId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "participantRole": "ACQUIRER",
  "transactionDate": "2026-06-15",
  "value": 150000,
  "arrangementCode": "0245",
  "authorizationCode": "A1B2C3",
  "brandCode": "VISA",
  "currency": "BRL",
  "establishmentCode": "EC-000123",
  "installmentNumber": 1,
  "intakeMode": "api_jsonl",
  "metadata": {},
  "originalOperationId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "pvCode": "PV-000123",
  "pvDocument": "12345678000195",
  "pvName": "Loja Exemplo LTDA",
  "pvPersonType": "J",
  "reasonCategory": "4",
  "settlementIfIspb": "60746948"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"creditorIspb\": \"29011780\",\n  \"domicileIfIspb\": \"60701190\",\n  \"dueDate\": \"2026-06-15\",\n  \"externalId\": \"acq-ext-2026-06-0001\",\n  \"installments\": 3,\n  \"operationType\": \"CREDIT\",\n  \"participantId\": \"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e\",\n  \"participantRole\": \"ACQUIRER\",\n  \"transactionDate\": \"2026-06-15\",\n  \"value\": 150000,\n  \"arrangementCode\": \"0245\",\n  \"authorizationCode\": \"A1B2C3\",\n  \"brandCode\": \"VISA\",\n  \"currency\": \"BRL\",\n  \"establishmentCode\": \"EC-000123\",\n  \"installmentNumber\": 1,\n  \"intakeMode\": \"api_jsonl\",\n  \"metadata\": {},\n  \"originalOperationId\": \"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e\",\n  \"pvCode\": \"PV-000123\",\n  \"pvDocument\": \"12345678000195\",\n  \"pvName\": \"Loja Exemplo LTDA\",\n  \"pvPersonType\": \"J\",\n  \"reasonCategory\": \"4\",\n  \"settlementIfIspb\": \"60746948\"\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    creditorIspb: '29011780',
    domicileIfIspb: '60701190',
    dueDate: '2026-06-15',
    externalId: 'acq-ext-2026-06-0001',
    installments: 3,
    operationType: 'CREDIT',
    participantId: '018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e',
    participantRole: 'ACQUIRER',
    transactionDate: '2026-06-15',
    value: 150000,
    arrangementCode: '0245',
    authorizationCode: 'A1B2C3',
    brandCode: 'VISA',
    currency: 'BRL',
    establishmentCode: 'EC-000123',
    installmentNumber: 1,
    intakeMode: 'api_jsonl',
    metadata: {},
    originalOperationId: '018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e',
    pvCode: 'PV-000123',
    pvDocument: '12345678000195',
    pvName: 'Loja Exemplo LTDA',
    pvPersonType: 'J',
    reasonCategory: '4',
    settlementIfIspb: '60746948'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

payload = {
    "creditorIspb": "29011780",
    "domicileIfIspb": "60701190",
    "dueDate": "2026-06-15",
    "externalId": "acq-ext-2026-06-0001",
    "installments": 3,
    "operationType": "CREDIT",
    "participantId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
    "participantRole": "ACQUIRER",
    "transactionDate": "2026-06-15",
    "value": 150000,
    "arrangementCode": "0245",
    "authorizationCode": "A1B2C3",
    "brandCode": "VISA",
    "currency": "BRL",
    "establishmentCode": "EC-000123",
    "installmentNumber": 1,
    "intakeMode": "api_jsonl",
    "metadata": {},
    "originalOperationId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
    "pvCode": "PV-000123",
    "pvDocument": "12345678000195",
    "pvName": "Loja Exemplo LTDA",
    "pvPersonType": "J",
    "reasonCategory": "4",
    "settlementIfIspb": "60746948"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "externalId": "acq-ext-2026-06-0001",
  "id": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "meta": {
    "requestId": "req-2026-06-15-abc123",
    "timestamp": "2026-06-15T10:50:00Z"
  },
  "state": "CREATED"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency

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

Minimum string length: 1

Example:

"29011780"

domicileIfIspb

string

required

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

Minimum string length: 1

Example:

"60701190"

dueDate

string

required

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

Minimum string length: 1

Example:

"2026-06-15"

externalId

string

required

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

Minimum string length: 1

Example:

"acq-ext-2026-06-0001"

installments

integer<int32>

required

Total number of installments; at least 1. The ceiling of 99 applies only to an enabled operation type and is enforced by the use case.

Required range: x >= 1

Example:

3

operationType

string

required

Operation type driving the settlement flow.

Minimum string length: 1

Example:

"CREDIT"

participantId

string

required

Participant id (UUID) that owns this operation.

Minimum string length: 1

Example:

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

participantRole

string

required

Participant role in the settlement.

Minimum string length: 1

Example:

"ACQUIRER"

transactionDate

string

required

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

Minimum string length: 1

Example:

"2026-06-15"

value

integer<int64>

required

Operation amount in minor units (centavos); strictly positive.

Required range: x >= 1

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 characters; 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"

Administration

Clearing

Settlement schedule

Funding

LBTR

Connectivity

Operations

Files

Participants

Arrangements

Reports

Signing keys

XSD schemas

Webhooks

Error handling

Create a settlement operation

Authorizations

Headers

Body

Response