Skip to main content
POST
Orchestrate Core operation

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Idempotency key, max 255 characters

Corpo

application/json
amount
integer<int64>
obrigatório

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

Intervalo obrigatório: x >= 1
Exemplo:

15000

commissionAmount
integer<int64>
obrigatório

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

Intervalo obrigatório: x >= 0
Exemplo:

10

endToEndId
string
obrigatório

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}$
Exemplo:

"E12345678202604281234ABCDE123456"

feeAmount
integer<int64>
obrigatório

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

Intervalo obrigatório: x >= 0
Exemplo:

25

operationId
string
obrigatório

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
Exemplo:

"op-20260428-0001"

senderISPB
string
obrigatório

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}$
Exemplo:

"12345678"

commissionRecipientISPB
string

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

Exemplo:

"87654321"

feePayerISPB
string

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

Exemplo:

"12345678"

Resposta

OK

commissionAmount
integer<int64>
obrigatório

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

Exemplo:

10

feeAmount
integer<int64>
obrigatório

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

Exemplo:

25

feeAttributionId
string
obrigatório

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

Exemplo:

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

operationId
string
obrigatório

Caller-assigned identifier echoed from the request.

Exemplo:

"op-20260428-0001"

routingDecision
object
obrigatório

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

sagaId
string
obrigatório

UUID of the orchestration saga coordinating the operation.

Exemplo:

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

sagaStatus
string
obrigatório

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

Exemplo:

"COMPLETED"

settlementId
string
obrigatório

UUID of the settlement created for this operation.

Exemplo:

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

settlementStatus
string
obrigatório

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

Exemplo:

"PENDING"

commissionRecipientISPB
string

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

Exemplo:

"87654321"

feePayerISPB
string

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

Exemplo:

"12345678"