Skip to main content
POST
Orquestrar operação Core

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key
string

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.

Exemplo:

15000

commissionAmount
integer<int64>
obrigatório

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

Exemplo:

10

endToEndId
string
obrigatório

PIX EndToEndID of the transaction, format E{ISPB}{YYYYMMDD}{uniqueID}.

Exemplo:

"E12345678202604281234ABCDE123456"

feeAmount
integer<int64>
obrigatório

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

Exemplo:

25

operationId
string
obrigatório

Caller-assigned idempotency/business identifier for the operation, max 128 characters.

Exemplo:

"op-20260428-0001"

senderISPB
string
obrigatório

ISPB of the sending participant, exactly 8 numeric digits.

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"