Orchestrate Core operation

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/core/operations/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": 15000,
  "commissionAmount": 10,
  "endToEndId": "E12345678202604281234ABCDE123456",
  "feeAmount": 25,
  "operationId": "op-20260428-0001",
  "senderISPB": "12345678",
  "commissionRecipientISPB": "87654321",
  "feePayerISPB": "12345678"
}
'

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/core/operations/"

	payload := strings.NewReader("{\n  \"amount\": 15000,\n  \"commissionAmount\": 10,\n  \"endToEndId\": \"E12345678202604281234ABCDE123456\",\n  \"feeAmount\": 25,\n  \"operationId\": \"op-20260428-0001\",\n  \"senderISPB\": \"12345678\",\n  \"commissionRecipientISPB\": \"87654321\",\n  \"feePayerISPB\": \"12345678\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 15000,
    commissionAmount: 10,
    endToEndId: 'E12345678202604281234ABCDE123456',
    feeAmount: 25,
    operationId: 'op-20260428-0001',
    senderISPB: '12345678',
    commissionRecipientISPB: '87654321',
    feePayerISPB: '12345678'
  })
};

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

import requests

url = "https://spi.sandbox.lerian.net/api/v1/core/operations/"

payload = {
    "amount": 15000,
    "commissionAmount": 10,
    "endToEndId": "E12345678202604281234ABCDE123456",
    "feeAmount": 25,
    "operationId": "op-20260428-0001",
    "senderISPB": "12345678",
    "commissionRecipientISPB": "87654321",
    "feePayerISPB": "12345678"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "commissionAmount": 10,
  "feeAmount": 25,
  "feeAttributionId": "550e8400-e29b-41d4-a716-446655440000",
  "operationId": "op-20260428-0001",
  "routingDecision": {
    "isDirect": false,
    "quotaConsumed": 15000,
    "indirectISPB": "12345678",
    "sponsorISPB": "87654321"
  },
  "sagaId": "550e8400-e29b-41d4-a716-446655440000",
  "sagaStatus": "COMPLETED",
  "settlementId": "550e8400-e29b-41d4-a716-446655440000",
  "settlementStatus": "PENDING",
  "commissionRecipientISPB": "87654321",
  "feePayerISPB": "12345678"
}

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

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

api

core

operations

Orchestrate Core operation

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/core/operations/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": 15000,
  "commissionAmount": 10,
  "endToEndId": "E12345678202604281234ABCDE123456",
  "feeAmount": 25,
  "operationId": "op-20260428-0001",
  "senderISPB": "12345678",
  "commissionRecipientISPB": "87654321",
  "feePayerISPB": "12345678"
}
'

package main

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

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/core/operations/"

	payload := strings.NewReader("{\n  \"amount\": 15000,\n  \"commissionAmount\": 10,\n  \"endToEndId\": \"E12345678202604281234ABCDE123456\",\n  \"feeAmount\": 25,\n  \"operationId\": \"op-20260428-0001\",\n  \"senderISPB\": \"12345678\",\n  \"commissionRecipientISPB\": \"87654321\",\n  \"feePayerISPB\": \"12345678\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 15000,
    commissionAmount: 10,
    endToEndId: 'E12345678202604281234ABCDE123456',
    feeAmount: 25,
    operationId: 'op-20260428-0001',
    senderISPB: '12345678',
    commissionRecipientISPB: '87654321',
    feePayerISPB: '12345678'
  })
};

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

import requests

url = "https://spi.sandbox.lerian.net/api/v1/core/operations/"

payload = {
    "amount": 15000,
    "commissionAmount": 10,
    "endToEndId": "E12345678202604281234ABCDE123456",
    "feeAmount": 25,
    "operationId": "op-20260428-0001",
    "senderISPB": "12345678",
    "commissionRecipientISPB": "87654321",
    "feePayerISPB": "12345678"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "commissionAmount": 10,
  "feeAmount": 25,
  "feeAttributionId": "550e8400-e29b-41d4-a716-446655440000",
  "operationId": "op-20260428-0001",
  "routingDecision": {
    "isDirect": false,
    "quotaConsumed": 15000,
    "indirectISPB": "12345678",
    "sponsorISPB": "87654321"
  },
  "sagaId": "550e8400-e29b-41d4-a716-446655440000",
  "sagaStatus": "COMPLETED",
  "settlementId": "550e8400-e29b-41d4-a716-446655440000",
  "settlementStatus": "PENDING",
  "commissionRecipientISPB": "87654321",
  "feePayerISPB": "12345678"
}

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

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

required

Idempotency key, max 255 characters

Body

application/json

amount

integer<int64>

required

Transaction amount in centavos (BRL minor units); must be greater than zero.

Required range: x >= 1

Example:

15000

commissionAmount

integer<int64>

required

Commission amount in centavos (BRL minor units); zero or positive.

Required range: x >= 0

Example:

10

endToEndId

string

required

PIX EndToEndID of the transaction, 32 characters, shaped as BACEN's EndToEndIdType (E, then the 8-character participant segment, then YYYYMMDDHHMM, then an 11-character unique tail). The date and minute components are additionally parsed as a real instant, and the participant segment must equal senderISPB, before the operation is accepted.

Pattern: ^E[0-9A-Z]{8}[0-9]{12}[a-zA-Z0-9]{11}$

Example:

"E12345678202604281234ABCDE123456"

feeAmount

integer<int64>

required

Fee amount in centavos (BRL minor units); zero or positive.

Required range: x >= 0

Example:

25

operationId

string

required

Caller-assigned idempotency/business identifier for the operation. Lerian's own bound, not BACEN's: 128 characters is what the orchestration command enforces and what core_sagas.operation_id stores.

Required string length: 1 - 128

Example:

"op-20260428-0001"

senderISPB

string

required

ISPB of the sending participant, exactly 8 numeric digits. BACEN's ISPBType admits [0-9A-Z]{8}; the participant registry this rail routes against stores 8 digits, so the door applies the narrower rule the service can actually satisfy.

Pattern: ^[0-9]{8}$

Example:

"12345678"

commissionRecipientISPB

string

ISPB of the participant receiving the commission (8 numeric digits); optional.

Example:

"87654321"

feePayerISPB

string

ISPB of the participant charged the fee (8 numeric digits); optional.

Example:

"12345678"

Response

commissionAmount

integer<int64>

required

Commission amount applied, in centavos (BRL minor units).

Example:

10

feeAmount

integer<int64>

required

Fee amount applied, in centavos (BRL minor units).

Example:

25

feeAttributionId

string

required

UUID of the fee attribution record; empty when no fee attribution was created.

Example:

"550e8400-e29b-41d4-a716-446655440000"

operationId

string

required

Caller-assigned identifier echoed from the request.

Example:

"op-20260428-0001"

routingDecision

object

required

Routing snapshot showing how the operation was directed through sponsor/indirect participants.

Show child attributes

sagaId

string

required

UUID of the orchestration saga coordinating the operation.

Example:

"550e8400-e29b-41d4-a716-446655440000"

sagaStatus

string

required

Current state of the orchestration saga (e.g. COMPLETED).

Example:

"COMPLETED"

settlementId

string

required

UUID of the settlement created for this operation.

Example:

"550e8400-e29b-41d4-a716-446655440000"

settlementStatus

string

required

Current state of the settlement (e.g. PENDING).

Example:

"PENDING"

commissionRecipientISPB

string

ISPB of the participant receiving the commission (8 numeric digits); omitted when no fee attribution applies.

Example:

"87654321"

feePayerISPB

string

ISPB of the participant charged the fee (8 numeric digits); omitted when no fee attribution applies.

Example:

"12345678"