Skip to main content
POST
Orquestar operación Core

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

Idempotency-Key
string

Idempotency key, max 255 characters

Cuerpo

application/json
amount
integer<int64>
requerido

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

Ejemplo:

15000

commissionAmount
integer<int64>
requerido

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

Ejemplo:

10

endToEndId
string
requerido

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

Ejemplo:

"E12345678202604281234ABCDE123456"

feeAmount
integer<int64>
requerido

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

Ejemplo:

25

operationId
string
requerido

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

Ejemplo:

"op-20260428-0001"

senderISPB
string
requerido

ISPB of the sending participant, exactly 8 numeric digits.

Ejemplo:

"12345678"

commissionRecipientISPB
string

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

Ejemplo:

"87654321"

feePayerISPB
string

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

Ejemplo:

"12345678"

Respuesta

OK

commissionAmount
integer<int64>
requerido

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

Ejemplo:

10

feeAmount
integer<int64>
requerido

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

Ejemplo:

25

feeAttributionId
string
requerido

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

Ejemplo:

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

operationId
string
requerido

Caller-assigned identifier echoed from the request.

Ejemplo:

"op-20260428-0001"

routingDecision
object
requerido

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

sagaId
string
requerido

UUID of the orchestration saga coordinating the operation.

Ejemplo:

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

sagaStatus
string
requerido

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

Ejemplo:

"COMPLETED"

settlementId
string
requerido

UUID of the settlement created for this operation.

Ejemplo:

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

settlementStatus
string
requerido

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

Ejemplo:

"PENDING"

commissionRecipientISPB
string

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

Ejemplo:

"87654321"

feePayerISPB
string

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

Ejemplo:

"12345678"