Saltar para o conteúdo principal
GET
curl
A API de histórico de entregas da Travel Rule da Didit devolve todas as entradas de entrega de uma transação, paginadas da mais antiga para a mais recente. Utilize a sua x-api-key com permissão de leitura sobre transações. transaction_id é o UUID da transação na Didit. Se a transação ou a transferência não existirem, a resposta é 404; se a permissão for insuficiente, a resposta é 403.

Paginação e ordenação

A resposta contém count, next, previous e results. limit tem como valor por omissão 100 e está limitado a 100; offset tem como valor por omissão zero e não pode exceder 1,000,000, caso em que devolve 400. count está normalmente limitado a 100 e não é um total fiável para históricos maiores. Siga next até ser null, independentemente do valor de count. As entradas são ordenadas pela data de criação e, em caso de empate, pelo identificador. Cada entrada tem uuid, kind, status, rail, created_at, delivered_at e detail_lines. rail é EMAIL, TRP, INTERNAL, NETWORK ou null antes da seleção. detail_lines descreve o tipo de mensagem e o estado, sem erros em bruto nem payloads de transporte.

Histórico incorporado

O detalhe da transação inclui apenas as 100 entradas mais recentes em travel_rule.deliveries, apresentadas da mais antiga para a mais recente. deliveries_truncated indica se foram omitidas entradas mais antigas. As listas de transações omitem estes dois campos de histórico. O campo existente delivery continua a descrever a entrega mais recente. Consulte entrega e novas tentativas para conhecer o significado dos estados. As mensagens da contraparte são um endpoint de conversa separado.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

transaction_id
string<uuid>
obrigatório

UUID de transação estável da Didit proprietário da transferência.

Parâmetros de consulta

limit
integer
padrão:100

Entradas por página. Por defeito, 100; valores superiores são limitados a 100; um valor acima de 1,000,000 devolve 400.

Intervalo necessário: 1 <= x <= 1000000
offset
integer
padrão:0

Número de entradas a ignorar, até 1,000,000. Um valor superior devolve 400.

Intervalo necessário: 0 <= x <= 1000000

Resposta

Histórico de entregas paginado, do mais antigo para o mais recente.

count
integer
obrigatório

A contagem está normalmente limitada a 100; não é um total fiável para históricos maiores. Siga next até null, independentemente da contagem.

Intervalo necessário: x >= 0
next
string<uri> | null
obrigatório

URL da página seguinte, ou null.

previous
string<uri> | null
obrigatório

URL da página anterior, ou null.

results
object[]
obrigatório

Entradas ordenadas da mais antiga para a mais recente, por data de criação e, depois, por identificador.

Última modificação em 12 de novembro de 2026