Skip to main content
POST
Create SME electronic-money movement

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Idempotency key. Required on every mutation.

X-TTL
string

Idempotency key TTL in seconds.

Corpo

application/json
amount
string
obrigatório

Movement amount as a decimal-reais string, forwarded verbatim into the SME submit — Lerian SPB performs NO arithmetic on it. Canonical form only: exactly two decimal places and no leading integer zeros — the single spelling the durable column stores; anything else is refused at the door with 422.

Pattern: ^(0|[1-9][0-9]*)\.[0-9]{2}$
Exemplo:

"1500.25"

kind
enum<string>
obrigatório

Operator-facing movement kind. deposit funds an IEME's conta correspondente a moeda eletrônica (CCME) from Reservas Bancárias / Conta de Liquidação (wire SME0001); withdrawal recalls funds out of the CCME (SME0002); return gives back an entry received in error (SME0004).

Opções disponíveis:
deposit,
withdrawal,
return
Exemplo:

"deposit"

counterpartyISPB
string

The other party's ISPB. On a deposit it is the OPTIONAL ISPBIEME whose CCME is credited (empty is the own-CCME deposit); on a return it is the REQUIRED credited IEME being paid back. A withdrawal names its credited FI inside creditedAccount instead, so supplying one there is refused.

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

"00038166"

creditedAccount
object

Withdrawal-only credited Reservas Bancárias account (all four children required when the group is present). Absent is the own-account withdrawal. Supplying it on a deposit or return is refused.

description
string

Return-only free-text history (Hist). SME0001 and SME0002 declare no such element, so supplying it there is refused.

Exemplo:

"devolucao lancamento indevido"

originalControlNumber
string

Return-only: the BACEN STR control number (NumCtrlSTROr) of the entry this return reverses. Required on a return; refused on a deposit or withdrawal.

Exemplo:

"20260619000001"

Resposta

Accepted

correlationId
string
obrigatório

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

Exemplo:

"req-7a3f9c2e"

operationId
string<uuid>
obrigatório

Server-assigned operation UUID identifying the accepted SME movement.

Exemplo:

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

status
enum<string>
obrigatório

Projection lifecycle status; PENDING on accept (awaiting the STR R-leg settlement confirmation).

Opções disponíveis:
PENDING,
SETTLED,
REJECTED
Exemplo:

"PENDING"

wireCode
enum<string>
obrigatório

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

Opções disponíveis:
SME0001,
SME0002,
SME0004
Exemplo:

"SME0001"