Saltar para o conteúdo principal
POST
curl

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.

Corpo

application/json
chain
string
obrigatório

Blockchain na qual o depósito foi liquidado, por exemplo ETH. Armazenada em minúsculas e comparada de forma insensível a maiúsculas/minúsculas com as entradas do seu livro de endereços de carteiras, pelo que deve utilizar o mesmo token de blockchain aí.

Maximum string length: 32
txid
string
obrigatório

Hash da transação on-chain. Deduplicado em conjunto com wallet_address.

Maximum string length: 128
wallet_address
string
obrigatório

A carteira de destino na qual recebeu o depósito. Um endereço X-address de XRP é dividido no respetivo endereço clássico e tag.

Maximum string length: 128
amount
string
obrigatório

Montante do depósito como uma string decimal, igual ou superior a zero, com até 18 casas decimais.

currency
string
obrigatório

Ativo do depósito, por exemplo, "USDC".

Maximum string length: 16
originator_data
object

Dados do ordenante do VASP remetente, se conhecidos, como um objeto simples, tal como {"name": "..."}. A Didit lê name (ou full_name), first_name, last_name e vendor_data a partir dele.

beneficiary_data
object

Detalhes do beneficiário (o seu cliente), como um objeto simples tal como {"name": "..."}. A Didit compara o nome com o holder_name da entrada correspondente do livro de endereços e define wallet_address e chain a partir do pedido.

originating_vasp
object

Descrição opcional do VASP remetente. Permanece apenas nesta transferência (metadata.originating_vasp, e o VASP ordenante da transferência em GET /v3/travel-rule/transfers/); nunca cria, edita ou associa uma entrada no diretório partilhado de VASPs.

memo
string

Opcional. A tag de destino ou memo do depósito numa rede que utilize memos: num endereço de depósito partilhado, é o que distingue os seus clientes, e é utilizada a entrada do livro de endereços correspondente a esse memo. XRP: uma tag de destino, um número inteiro de 0 a 4294967295 (um número JSON é aceite). XLM: um memo de texto até 28 bytes, um ID de 64 bits ou um hash de 32 bytes em hexadecimal. EOS: até 256 bytes. ATOM: até 256 carateres. HBAR: até 100 bytes. As carteiras Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin e Lightning não aceitam memo: incluir um devolve 400. Pseudónimo: destinationTag ou destination_tag.

Maximum string length: 256
utxo
object

Opcional, apenas para cadeias UTXO. As entradas e saídas da transação de depósito: a carteira do remetente é o originator_data.wallet_address declarado; caso contrário, a maior entrada.

Resposta

Já foi registada uma transferência para este txid e wallet_address; a existente é devolvida sem alterações (created é false).

transaction_id
string<uuid>

UUID da transação Didit para o depósito recebido.

txn_id
string

txn_id da transação de entrada: gerado pela Didit quando a Didit criou a transação, ou o seu próprio identificador quando um depósito não reclamado foi reutilizado.

created
boolean

true quando esta chamada registou a transferência (HTTP 201); false quando já existia uma transferência para o mesmo txid e wallet_address (HTTP 200).

travel_rule
object

Objeto completo de transferência devolvido pelos endpoints de confirmação de propriedade e de finalização/cancelamento. Enquanto a propriedade da carteira de uma transferência recebida não estiver confirmada, os campos originator_data e beneficiary_data da contraparte são devolvidos mascarados (a primeira letra de cada palavra é mantida; a carteira, a blockchain e o encaminhamento do VASP permanecem legíveis) e data_masked é true.

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