Saltar al contenido principal
POST
Return a TED credit received before Lerian SPB

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Idempotency key. Required on every mutation.

X-TTL
string

Seconds the cached response is kept; it may only shorten IDEMPOTENCY_DEFAULT_TTL_SEC. The key itself lives with the operation.

Cuerpo

application/json
amount
string
requerido

The credit's full amount, as a decimal string with exactly two places (VlrLanc of the STR0010). The STR refuses an amount above the original's (ESTR0025); no refusal of a smaller one is documented for STR0010.

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

"150.00"

numCtrlSTROr
string
requerido

NumCtrlSTR of the TED credit being returned, as its STR0004R2..STR0008R2 carried it (NumCtrlSTROr of the STR0010; official type Controle, XXXAAAAMMDDnnnnnnnnn, whose date must parse).

Required string length: 20
Ejemplo:

"STR20261020000000123"

originalSenderIspb
string
requerido

ISPB of the institution that sent the credit (its ISPBIFDebtd), which the return credits.

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

"12345678"

returnCode
enum<string>
requerido

BACEN return reason (CodDevTransf) of the STR0010: one of the codes the BACEN dicionário de domínios keeps active, without a leading zero (type CodDevTransf, Catálogo v5.13 Vol IV). The retired 10-14, 78, 79 and 81 are refused.

Opciones disponibles:
1,
2,
3,
4,
5,
6,
7,
8,
9,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
31,
40,
51,
52,
53,
61,
63,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
80,
82,
83,
84,
85,
86
Ejemplo:

"1"

description
string

Optional free-text description of the return (Hist).

Ejemplo:

"Wrong account"

metadata
object

Opaque client-side metadata forwarded verbatim to the legacy submit DTO; not persisted on the return intent.

Respuesta

Created

acceptedAt
string<date-time>
requerido

UTC RFC 3339 timestamp at which the command was accepted.

Ejemplo:

"2026-05-06T18:30:00Z"

capabilityId
string
requerido

STR capability identifier resolved for the accepted operation (e.g. STR0004).

Ejemplo:

"STR0004"

correlationId
string
requerido

Request correlation identifier for tracing the accept across logs and traces.

Ejemplo:

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

isReplay
boolean
requerido

True when this response replays a prior idempotent accept rather than creating a new operation.

Ejemplo:

false

operationFamily
enum<string>
requerido

Operation family the accepted command belongs to (e.g. bankTransfer).

Opciones disponibles:
bankTransfer
Ejemplo:

"bankTransfer"

operationId
string<uuid>
requerido

Server-assigned operation aggregate UUID used for subsequent status, return, and cancellation calls.

Ejemplo:

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

status
enum<string>
requerido

Current control-plane lifecycle status of the operation; ACCEPTED on initial accept.

Opciones disponibles:
ACCEPTED,
SUBMITTED,
SENT,
CONFIRMED,
REJECTED,
FAILED,
PENDING_CONFIGURATION,
PENDING_RECONCILIATION,
RETURN_REQUESTED,
RETURNED,
CANCEL_REQUESTED,
CANCELLED,
RECEIVED,
DELIVERED
Ejemplo:

"ACCEPTED"

protocolMetadata
object

Optional SAFE protocol correlation fields; present once the operation is mapped to STR wire identifiers.