List held returns with no settled original TED (operator)

Operator action that lists the open held returns: returns (STR0010R2) received from the STR for TEDs that no SETTLED transfer of this institution carries by NumCtrlSTR. Nobody has been refunded yet. Oldest first, without pagination.

Each item says whether a TED Lerian transfer carries the returned NumCtrlSTR (transferId and transferStatus) or not (null: no TED Lerian transfer carries it). Decide by transferStatus: REJECTED or CANCELLED means the sender was never debited, so there is nothing to credit and you must never credit the sender. A transfer that can still settle is refunded by TED Lerian itself when it settles. Close the others with POST /v1/reconciliation/held-returns/{heldReturnId}/close, giving the ledger transaction that evidences the outcome.

GET /v1/reconciliation/held-returns

List held returns with no settled original TED (operator)

cURL

curl --request GET \
  --url https://api.example.com/v1/reconciliation/held-returns \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "amount": "1500.00",
      "id": "0d3f8c1a-6b2e-4a7c-9d5f-1e2a3b4c5d6e",
      "originalNumCtrlStr": "STR20261022000000123",
      "returnCode": "1",
      "returnedAt": "2026-10-22T14:10:05Z",
      "transferId": null,
      "transferStatus": null
    },
    {
      "amount": "250.00",
      "id": "7a9c2e4f-1b3d-4c5e-8f6a-2d4b6c8e0a1f",
      "originalNumCtrlStr": "STR20261022000000456",
      "returnCode": "2",
      "returnedAt": "2026-10-22T14:12:30Z",
      "transferId": "6f1c2b3a-4d5e-4f60-8a9b-0c1d2e3f4a5b",
      "transferStatus": "REJECTED"
    }
  ]
}

Autorizações

Authorization · string · header · obrigatório

JWT token that the Lerian Access Manager issues for your institution. Send it in Authorization: Bearer <token> on every call (except the public health probes). The tenant never comes from the body, the query, or the path. Each operation requires a role with the matching permission (see the API overview). Without it, 403 TED-0071. Missing, invalid, or expired token: 401 TED-0070.

Cabeçalhos

X-Request-Id · string<uuid>

Correlation identifier of this request (UUID). Optional: when you omit it, or when the value is not a well-formed UUID, the platform creates a UUID and returns it in the X-Request-Id header of the response. The resolved identifier goes to the logs, spans, and audit events of this request. Keep it to open a support ticket.

Resposta

200

application/json

Open held returns, oldest first.

Open held returns, oldest first, without pagination.

items · object[] · obrigatório

Open held returns, oldest first.

Show child attributes