Rastrear liquidação ou devolução de TED

POST

/api/CashOut/ConsultarDocTed

CashOut

Funcionalidade principal

O endpoint ConsultarDocTed recupera o status detalhado de uma solicitação de TED enviada anteriormente. Ele é utilizado para confirmar a liquidação da transação ou identificar o motivo técnico de uma eventual devolução (como agência ou conta inválida).

Casos de uso comuns

Polling de status: O sistema do parceiro consulta a API periodicamente para atualizar o extrato do cliente final de "Pendente" para "Concluído".

Tratamento de erros: Identificar por que um TED "voltou", permitindo que o usuário corrija os dados bancários e tente novamente.

Auditoria e reconciliação: Cruzar os dados da Pinbank com o sistema interno do integrador para garantir que todas as saídas de caixa foram processadas.

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/ConsultarDocTed' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "NossoNumero": "string"
    }
}'

Response Example

{
    "Data": {
        "NossoNumero": "string",
        "CpfCnpj": "string",
        "NomeFavorecido": "string",
        "NomeBanco": "string",
        "CodigoBanco": 0,
        "Agencia": "string",
        "Conta": "string",
        "TipoPessoa": "Fisica",
        "TipoConta": "Corrente",
        "Data": "string",
        "Status": "string"
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

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

Página anterior

Solicitar retirada de fundos via TED

Próxima página

Registrar TED para aprovação posterior

Rastrear liquidação ou devolução de TED

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns