Recuperar um saque
Consulte os valores, o destino e a situação de um saque pelo identificador.
Consulte um saque pelo identificador recebido na listagem ou na referência de um lançamento do extrato. A resposta informa os valores, o destino disponível e a situação atual, na empresa e no ambiente autenticado.
Consultar não altera o saque nem acelera sua conclusão. Veja como acompanhar o resultado em Saques.
Parâmetros de caminho
Identificador do saque, com prefixo wd_.
Até 100 caracteres
Respostas
Corpo da resposta
Dados do saque no momento da consulta. A requisição não solicita, cancela nem repete uma transferência.
Identificador público do saque, com prefixo wd_. Também pode aparecer como reference_id no extrato.
Valor solicitado para saque, em centavos de real, incluindo a tarifa. Um saque pendente, com falha ou cancelado não confirma a transferência desse valor.
Tarifa do saque, em centavos de real. A tarifa é cobrada quando o saque é concluído; falha ou cancelamento não confirma cobrança.
Valor destinado à conta de destino, em centavos de real: amount_cents menos fee_amount_cents. Consulte status para saber se a transferência foi concluída.
Estado atual do saque. PENDING: aguardando processamento; PROCESSING: em processamento; COMPLETED: concluído; FAILED: falhou; CANCELED: cancelado; UNKNOWN: estado sem classificação disponível. Apenas COMPLETED confirma a conclusão.
Motivo conhecido da falha, ou null quando o saque não está em FAILED. Um motivo indisponível não deve ser interpretado como autorização para repetir o saque.
Motivo registrado para a falha. Consulte os códigos e a orientação de tratamento em Falhas de saque.
Explicação da falha em inglês. O texto ajuda no diagnóstico; a integração deve usar code.
Conta de destino registrada em um saque bancário, ou null quando não se aplica. O número da conta é apresentado parcialmente.
Código do banco de destino registrado no saque.
Agência registrada no saque, com dígito quando informado, ou null.
Número parcialmente oculto da conta de destino, com dígito quando informado, ou null.
Destino Pix registrado para o saque, ou null quando não há dados disponíveis. A chave é apresentada parcialmente.
Tipo da chave usada no saque: CNPJ, EVP (aleatória), PHONE (telefone) ou EMAIL.
Chave Pix parcialmente oculta.
Nome do titular do destino registrado no saque.
ISPB da instituição de destino.
Instante da solicitação, em segundos Unix UTC.
Instante da conclusão, em segundos Unix UTC, ou null quando não houve conclusão.
Instante da falha, em segundos Unix UTC, ou null quando não houve falha.
Instante do cancelamento, em segundos Unix UTC, ou null quando não houve cancelamento.
Corpo da resposta
Há um parâmetro inválido. Confira error.details para identificar o campo e o formato aceito.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Corpo da resposta
O saque não foi encontrado na empresa e no ambiente autenticado.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Para os erros gerais, consulte Códigos HTTP das respostas.