Recuperar um lançamento
Consulte um lançamento do extrato pelo seu identificador.
Consulte o valor, o tipo e os vínculos de um lançamento da empresa e do
ambiente autenticado. Use o id com prefixo st_ recebido na listagem.
Os vínculos com estorno ou contestação aparecem somente quando estão identificados para aquele lançamento.
Veja Extrato para interpretar os valores e as referências retornadas.
Consulte também o mapa de tipos e identificadores para interpretar códigos e referências de outros recursos.
Parâmetros de caminho
Identificador do lançamento retornado na consulta do extrato.
Até 100 caracteres
Respostas
Corpo da resposta
Lançamento encontrado no extrato.
Identificador público do lançamento, com prefixo st_.
Identificador do recurso relacionado, ou null quando não houver referência. Cobranças usam ch_, contestações usam dp_, saques usam wd_ e ajustes usam adj_. Referências manuais podem não ter prefixo.
Categoria da referência: 1 cobrança; 2 contestação; 3 saque; 4 ajuste; 5 lançamento manual. Retorna null quando não houver referência.
Natureza do lançamento. Recebimentos, créditos por ajuste e liberações têm valor positivo; tarifas, saques, devoluções, débitos por ajuste e bloqueios têm valor negativo.
Valor assinado do lançamento em centavos de real. Por exemplo, 10000 representa R$ 100,00 e -149 representa uma saída de R$ 1,49.
Instante do lançamento em segundos Unix UTC.
ID do estorno que originou o lançamento, ou null quando não houver vínculo confirmado.
ID da contestação vinculada ao lançamento, ou null quando não houver vínculo confirmado. Um bloqueio sem contestação identificada mantém este campo nulo.
Corpo da resposta
Identificador de lançamento inválido.
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
Lançamento não 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.