Crear operación de devolución de transferencia bancaria

Prerrequisito: la operación padre debe estar SETTLED antes de una devolución; lee su estado mediante getOperation (GET /v1/str/operations/); el segmento de ruta vincula estructuralmente la devolución con su padre. El handler resuelve la operación original por operationId, valida que el estado del ciclo de vida admita una devolución (SPB-3006 en caso contrario) y delega en la ruta de devolución STR0010. Idempotente: reenviar la misma clave X-Idempotency con el mismo cuerpo devuelve la respuesta en caché.

POST /v1/str/operations/bank-transfers/{operationId}/returns

Crear operación de devolución de transferencia bancaria

cURL

curl --request POST \
  --url https://spb.sandbox.lerian.net/v1/str/operations/bank-transfers/{operationId}/returns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipientIspb": "<string>",
  "returnCode": "<string>",
  "senderIspb": "<string>",
  "amount": "<string>",
  "description": "<string>",
  "metadata": {}
}
'

201

{
  "acceptedAt": "2023-11-07T05:31:56Z",
  "capabilityId": "<string>",
  "correlationId": "<string>",
  "isReplay": true,
  "operationFamily": "<string>",
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "protocolMetadata": {
    "controlNumber": "<string>",
    "nuOp": "<string>"
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization · string

Bearer JWT token.

X-Idempotency · string

Idempotency key (canonical).

X-Idempotency-Key · string

Idempotency key (legacy alias).

X-TTL · string

Idempotency key TTL in seconds.

Parámetros de ruta

operationId · string · requerido

Original bank-transfer operation UUID.

Cuerpo

application/json

recipientIspb · string · requerido

ISPB of the participant receiving the return, the 8-digit BACEN institution identifier.

Ejemplo:

38166

returnCode · string · requerido

BACEN STR return reason code (devolução) for the reversal.

Ejemplo:

"01"

senderIspb · string · requerido

ISPB of the participant initiating the return, the 8-digit BACEN institution identifier.

Ejemplo:

"12345678"

amount · string

Optional partial return amount as a decimal string in BRL, minor-unit precision; defaults to the full original amount when omitted.

Pattern: ^[0-9]+(\.[0-9]+)?$

Ejemplo:

"50.00"

description · string

Optional free-text description of the return.

Ejemplo:

"Wrong account"

metadata · object

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

Show child attributes

Respuesta

201

application/json

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 · string · requerido

Operation family the accepted command belongs to (e.g. 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 · string · requerido

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

Ejemplo:

"ACCEPTED"

protocolMetadata · object

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

Show child attributes