Skip to main content
GET
Get SME electronic-money movement status

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

operationId
string<uuid>
required

SME movement operation UUID returned by the create endpoint.

Response

OK

amount
string
required

Movement amount as a decimal-reais string, verbatim.

Example:

"1500.25"

correlationId
string
required

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Example:

"req-7a3f9c2e"

kind
enum<string>
required

Operator-facing movement kind the request named.

Available options:
deposit,
withdrawal,
return
Example:

"deposit"

operationId
string<uuid>
required

Operation UUID.

Example:

"7c8b3a2e-9f1d-4a55-9b8e-1e1234567890"

status
enum<string>
required

Projection lifecycle status: PENDING (awaiting the STR R-leg), SETTLED (R-leg confirmed), or REJECTED.

Available options:
PENDING,
SETTLED,
REJECTED
Example:

"PENDING"

wireCode
enum<string>
required

SME wire code derived server-side from the kind: deposit=SME0001, withdrawal=SME0002, return=SME0004.

Available options:
SME0001,
SME0002,
SME0004
Example:

"SME0001"

nuOp
string

SFN operation number stamped on the transmitted SME frame. Empty until the movement has been submitted to STR.

Pattern: ^[0-9A-Z]{8}[0-9]{15}$
Example:

"12345678202606190000001"

numCtrlSTR
string

STR control number BACEN sent on the R-leg settlement confirmation, verbatim. Empty while PENDING.

Example:

"20260619000001"

rejectionReason
string

Failure detail when the status is REJECTED. Empty otherwise.

Example:

"insufficient reserve balance"

sitLancSTR
string

STR settlement status BACEN sent on the R-leg, verbatim. Empty while PENDING.

Example:

"LIQ"