Listar TEDs por status ou referência

POST

/api/CashOut/ConsultarTed

CashOut

Funcionalidade principal

O ConsultarTed permite que o integrador verifique o ciclo de vida da transferência externa. Ele informa se a transação ainda está em fila, se já foi enviada para o Banco Central ou se foi devolvida (estornada) por erro de agência, conta ou CPF divergente.

Casos de uso comuns

Atualização de extrato: O sistema de backend consulta o status para atualizar a interface do usuário de "Em processamento" para "Concluído".

Tratamento de erros: Identificar o motivo exato de uma devolução para notificar o cliente para que ele corrija os dados bancários.

Auditoria financeira: Confirmar se o valor debitado da conta digital foi efetivamente transmitido para a rede bancária externa.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/CashOut/ConsultarTed' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "CodigoReferencia": "string",
        "IdTedProgramada": 0
    }
}'

Response Example

{
    "Data": [
        {
            "CodigoCliente": 0,
            "CodigoCanal": 0,
            "CodigoReferencia": "string",
            "IdTedProgramada": 0,
            "Status": "string",
            "ValorPrevisto": 0,
            "ValorAprovado": 0,
            "DataCadastro": "string",
            "DataAprovacao": "string",
            "CodigoAprovacao": "string",
            "NomeFavorecido": "string",
            "CpfCnpjFavorecido": "string",
            "TipoPessoa": "Fisica",
            "TipoConta": "Corrente",
            "CodigoBanco": "string",
            "NomeBanco": "string",
            "Agencia": "string",
            "DigitoAgencia": "string",
            "Conta": "string",
            "DigitoConta": "string",
            "Observacao": "string"
        }
    ],
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:24:53

Página anterior

Registrar TED para aprovação posterior

Próxima página

Cancelar TED

Listar TEDs por status ou referência

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns