Get incoming TED
Returns the current state of an incoming TED: status, the amount received and credited, the sender, the recipient (with recipient.accountId when the account was found), the regulatory deadline (slaDeadlineAt, 60 minutes after interbankSettledAt), and, when applicable, the manual review reason (reviewReason) or the return code (returnCode).
States: RECEIVED (decision in progress), CREDITED (credited to the customer), RECORDED (the institution’s own account), MANUAL_REVIEW (waits for an operator), RETURN_REQUESTED (return sent to the STR), and RETURNED (return confirmed). If the STR refuses a return, the TED goes back to MANUAL_REVIEW with reviewReason filled in.
You only see TEDs that your institution received. For the sequence of transitions, use GET /v1/incoming-transfers/{incomingTransferId}/timeline.
Autorizaciones
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.
Encabezados
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.
Parámetros de ruta
Identifier of the incoming TED
Respuesta
Incoming TED found, in its current status.
An incoming TED from another institution: amount, parties, regulatory credit deadline, and the state of the credit to the recipient. status=MANUAL_REVIEW with reviewReason indicates that the operation needs a human decision.
Amount in BRL as a decimal string with two decimal places.
^(0\.(0[1-9]|[1-9][0-9])|[1-9][0-9]{0,11}\.[0-9]{2})$"1500.00"
Time (UTC) when this service recorded the TED.
Identifier of the incoming TED. Use it in queries and actions.
Interbank settlement reported by the STR (start of the 60-min deadline)
Unique operation number on the rail (ISPB[8]+AAAAMMDD[8]+SEQ[7])
^[0-9]{23}$Recipient in your own institution; accountId is present when the account was found.
Sender, at another institution.
Regulatory deadline to credit or return: interbankSettledAt + 60 min (UTC).
Current state: RECEIVED (received from the STR, credit decision in progress) → CREDITED (credited to the customer), RECORDED (the institution's own account, terminal), or MANUAL_REVIEW (waits for an operator; see reviewReason); RETURN_REQUESTED (return sent to the STR) → RETURNED (confirmed, terminal). If the STR refuses a return, the TED goes back to MANUAL_REVIEW with reviewReason filled in.
RECEIVED, CREDITED, RECORDED, RETURN_REQUESTED, RETURNED, MANUAL_REVIEW Timestamp (UTC) of the last update to the record.
Amount actually credited to the recipient (amount − feeAmount), in BRL. Present from CREDITED onward.
^(0|[1-9][0-9]{0,11})\.[0-9]{2}$"1500.00"
Time (UTC) of the credit to the recipient.
Description given by the sender.
Fee applied to the credit, in BRL (0.00 when exempt).
^(0|[1-9][0-9]{0,11})\.[0-9]{2}$"0.00"
Credit to a customer or to the institution's own account
CLIENT, INSTITUTION Entry identifier assigned by the STR (20 characters).
^[A-Za-z0-9]{20}$Organization resolved through the ISPB→organization binding
Purpose code sent by the sender (FinlddCli, 5 digits).
^[0-9]{5}$"00010"
Official return reason (CodDevTransf) of the active return, when there is one.
^[0-9]{1,2}$"3"
Instant (UTC) when the STR confirmed the return.
Reason for the manual review, when status=MANUAL_REVIEW. From the credit decision: ISPB_BINDING_UNRESOLVED, ACCOUNT_NOT_FOUND, ACCOUNT_INACTIVE, HOLDER_MISMATCH, ACCOUNT_TYPE_INCOMPATIBLE, ENRICHMENT_INCOMPLETE, RAIL_INDETERMINATE, LEDGER_INDETERMINATE, REGISTRY_INDETERMINATE. From the return cycle: RETURN_REFUSED_BY_STR, RETURN_REQUEST_MALFORMED, RETURN_CODE_UNMAPPED, RETURN_REJECTED_BY_STR.