Skip to main content
GET
Read an SLB payment

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

nuOp
string
required

Correlation id returned by POST /v1/str/slb-payments or POST /v1/str/slb-bacen-payments (the outbound NUOp; 23 characters: ISPB[8]+DATE[8]+SEQ[7]).

Required string length: 23
Pattern: ^[0-9A-Z]{8}[0-9]{15}$

Response

OK

amount
string
required

Payment amount (VlrLanc), verbatim as text — never parsed or summed.

Example:

"1500.00"

correlationId
string
required

Request-scoped correlation identifier echoing X-Request-ID.

Example:

"req-7a3f9c2e"

id
string
required

Correlation id (the outbound NUOp).

Example:

"46026562202609150000001"

movementDate
string
required

Business date (DtMovto) stamped on the frame.

Example:

"2026-09-15"

numCtrlPart
string
required

This participant's own control number for the payment.

Example:

"20260915000000000001"

status
enum<string>
required

PENDING until an answer arrives AND that answer reports a settlement. An answer carrying a pending-class situation (the entry was taken, not yet settled) leaves this PENDING with sitLancSLB recorded — it is never read as payment.

Available options:
PENDING,
SETTLED,
REJECTED,
CANCELLED
Example:

"PENDING"

wireCode
enum<string>
required

SLB0002 pays a charge BACEN raised; SLB0007 pays BACEN an amount SLB never demanded.

Available options:
SLB0002,
SLB0007
Example:

"SLB0002"

agreementCnpj
string

Agreement CNPJ (CNPJConv), verbatim.

Example:

"00038166000105"

description
string

Free text (Hist). Present on SLB0007 only — SLB0002 declares none.

Example:

"DEVOLUCAO DE CREDITO"

numCtrlSLB
string

Entry BACEN minted for the payment, from an SLB0007R1. Blank on the SLB0002 path, where the entry already existed.

Example:

"SLB20260915000000020"

numCtrlSTR
string

STR entry the settlement rode, verbatim.

Example:

"STR20260915000000009"

originalControlNumber
string

On SLB0002, the charge being paid (mandatory). On SLB0007, the SLB0005 credit being returned (optional).

Example:

"SLB20260915000000001"

preferenceLevel
string

Processing preference (NivelPref), verbatim.

Example:

"0001"

purpose
string

BACEN finalidade code (FinlddSLB). Present on SLB0007 only — SLB0002 declares none.

Example:

"01"

rejectionReason
string

Operator-facing text of a refusal, verbatim.

Example:

"saldo insuficiente"

settledAt
string<date-time>

RFC3339 UTC timestamp the payment became terminal. Empty while PENDING.

Example:

"2026-09-15T18:00:01Z"

sitLancSLB
string

Situation code the answer carried, verbatim. It is BACEN's word on the entry, and it — not the fact that we sent the request — is what decides the status above.

Example:

"1"