Travel Rule 转账操作 API：完成、取消、重新发送、更新

curl

curl -X PATCH https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/ \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"payment_txn_id": "0xchainhash"}'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.transactions.travel_rule.update_transfer(
    "11111111-2222-3333-4444-555555555555",
    payment_txn_id="0xchainhash",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.transactions.travelRule.updateTransfer("11111111-2222-3333-4444-555555555555", {
  payment_txn_id: "0xchainhash",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Transactions.TravelRule.UpdateTransfer(ctx, "11111111-2222-3333-4444-555555555555", didit.TravelRuleTransferPatchRequest{
	PaymentTxnID: didit.String("0xchainhash"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.TravelRuleTransferPatchRequest;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.transactions().travelRule().updateTransfer("11111111-2222-3333-4444-555555555555", TravelRuleTransferPatchRequest.builder()
        .paymentTxnId("0xchainhash")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->transactions->travelRule->updateTransfer('11111111-2222-3333-4444-555555555555', [
    'payment_txn_id' => '0xchainhash',
]);
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.transactions.travel_rule.update_transfer(
  "11111111-2222-3333-4444-555555555555",
  payment_txn_id: "0xchainhash"
)
puts result.to_h

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Transactions.TravelRule.UpdateTransferAsync("11111111-2222-3333-4444-555555555555", new TravelRuleTransferPatchRequest
{
    PaymentTxnId = "0xchainhash",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "AWAITING_COUNTERPARTY",
  "direction": "INBOUND",
  "rail": "INTERNAL",
  "protocol": "<string>",
  "ivms_version": "ivms101.2023",
  "required": true,
  "ownership_confirmed": true,
  "deadline_at": "2023-11-07T05:31:56Z",
  "timeline": [
    {
      "status": "<string>",
      "at": "2023-11-07T05:31:56Z",
      "detail": "<string>",
      "name_match": {
        "score": 50,
        "matched": true,
        "method": "none",
        "strictness": "NONE",
        "compared_with": "wallet_holder",
        "transfer_name": "<string>",
        "compared_name": "<string>",
        "matched_names": [
          "<string>"
        ],
        "mismatched_names": [
          "<string>"
        ]
      },
      "reason": "<string>"
    }
  ],
  "counterparty_vasp": {
    "name": "<string>",
    "lei": "<string>",
    "dd_score": 123,
    "dd_score_breakdown": {},
    "dd_assessed_at": "2023-11-07T05:31:56Z"
  },
  "originator_data": {},
  "beneficiary_data": {},
  "name_match": {
    "score": 50,
    "matched": true,
    "method": "none",
    "strictness": "NONE",
    "compared_with": "wallet_holder",
    "transfer_name": "<string>",
    "compared_name": "<string>",
    "matched_names": [
      "<string>"
    ],
    "mismatched_names": [
      "<string>"
    ]
  },
  "data_match": {
    "matched": true,
    "mismatched_fields": [
      "name"
    ],
    "fields": {}
  },
  "mismatched_fields": [
    "<string>"
  ],
  "data_unmasked": {
    "at": "2023-11-07T05:31:56Z",
    "reason": "ownership_confirmed",
    "actor": "<string>"
  },
  "data_masked": true,
  "created_at": "2023-11-07T05:31:56Z",
  "delivery": {
    "kind": "SEND",
    "status": "QUEUED",
    "rail": "INTERNAL",
    "attempts": 1,
    "last_error": "email undeliverable",
    "next_attempt_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z"
  },
  "discovery": [
    {
      "step": "internal_address_book",
      "outcome": "match",
      "reason": "<string>",
      "vasp": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rail": "<string>",
      "at": "2023-11-07T05:31:56Z"
    }
  ],
  "reason": "<string>",
  "next_actions": [
    {
      "action": "select_counterparty_vasp",
      "url": "<string>"
    }
  ],
  "chain_details": {
    "chain": "<string>",
    "shape": "utxo",
    "originator": {
      "address": "<string>",
      "memo": "<string>",
      "source": "declared"
    },
    "beneficiary": {
      "address": "<string>",
      "memo": "<string>",
      "source": "declared"
    },
    "utxo": {
      "inputs": [
        {
          "address": "<string>",
          "amount": "0.0125",
          "txid": "<string>",
          "vout": 1
        }
      ],
      "outputs": [
        {
          "address": "<string>",
          "amount": "0.0125",
          "txid": "<string>",
          "vout": 1
        }
      ],
      "change_output_indexes": [
        123
      ],
      "beneficiary_output_index": 123
    },
    "lightning": {},
    "warnings": [
      "declared_originator_not_an_input"
    ],
    "not_applicable_reason": "LIGHTNING_NO_PAYEE_IDENTIFIER"
  }
}

PATCH

transactions

{transaction_id}

travel-rule

curl

curl -X PATCH https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/ \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"payment_txn_id": "0xchainhash"}'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.transactions.travel_rule.update_transfer(
    "11111111-2222-3333-4444-555555555555",
    payment_txn_id="0xchainhash",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.transactions.travelRule.updateTransfer("11111111-2222-3333-4444-555555555555", {
  payment_txn_id: "0xchainhash",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Transactions.TravelRule.UpdateTransfer(ctx, "11111111-2222-3333-4444-555555555555", didit.TravelRuleTransferPatchRequest{
	PaymentTxnID: didit.String("0xchainhash"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.TravelRuleTransferPatchRequest;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.transactions().travelRule().updateTransfer("11111111-2222-3333-4444-555555555555", TravelRuleTransferPatchRequest.builder()
        .paymentTxnId("0xchainhash")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->transactions->travelRule->updateTransfer('11111111-2222-3333-4444-555555555555', [
    'payment_txn_id' => '0xchainhash',
]);
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.transactions.travel_rule.update_transfer(
  "11111111-2222-3333-4444-555555555555",
  payment_txn_id: "0xchainhash"
)
puts result.to_h

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Transactions.TravelRule.UpdateTransferAsync("11111111-2222-3333-4444-555555555555", new TravelRuleTransferPatchRequest
{
    PaymentTxnId = "0xchainhash",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "AWAITING_COUNTERPARTY",
  "direction": "INBOUND",
  "rail": "INTERNAL",
  "protocol": "<string>",
  "ivms_version": "ivms101.2023",
  "required": true,
  "ownership_confirmed": true,
  "deadline_at": "2023-11-07T05:31:56Z",
  "timeline": [
    {
      "status": "<string>",
      "at": "2023-11-07T05:31:56Z",
      "detail": "<string>",
      "name_match": {
        "score": 50,
        "matched": true,
        "method": "none",
        "strictness": "NONE",
        "compared_with": "wallet_holder",
        "transfer_name": "<string>",
        "compared_name": "<string>",
        "matched_names": [
          "<string>"
        ],
        "mismatched_names": [
          "<string>"
        ]
      },
      "reason": "<string>"
    }
  ],
  "counterparty_vasp": {
    "name": "<string>",
    "lei": "<string>",
    "dd_score": 123,
    "dd_score_breakdown": {},
    "dd_assessed_at": "2023-11-07T05:31:56Z"
  },
  "originator_data": {},
  "beneficiary_data": {},
  "name_match": {
    "score": 50,
    "matched": true,
    "method": "none",
    "strictness": "NONE",
    "compared_with": "wallet_holder",
    "transfer_name": "<string>",
    "compared_name": "<string>",
    "matched_names": [
      "<string>"
    ],
    "mismatched_names": [
      "<string>"
    ]
  },
  "data_match": {
    "matched": true,
    "mismatched_fields": [
      "name"
    ],
    "fields": {}
  },
  "mismatched_fields": [
    "<string>"
  ],
  "data_unmasked": {
    "at": "2023-11-07T05:31:56Z",
    "reason": "ownership_confirmed",
    "actor": "<string>"
  },
  "data_masked": true,
  "created_at": "2023-11-07T05:31:56Z",
  "delivery": {
    "kind": "SEND",
    "status": "QUEUED",
    "rail": "INTERNAL",
    "attempts": 1,
    "last_error": "email undeliverable",
    "next_attempt_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z"
  },
  "discovery": [
    {
      "step": "internal_address_book",
      "outcome": "match",
      "reason": "<string>",
      "vasp": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rail": "<string>",
      "at": "2023-11-07T05:31:56Z"
    }
  ],
  "reason": "<string>",
  "next_actions": [
    {
      "action": "select_counterparty_vasp",
      "url": "<string>"
    }
  ],
  "chain_details": {
    "chain": "<string>",
    "shape": "utxo",
    "originator": {
      "address": "<string>",
      "memo": "<string>",
      "source": "declared"
    },
    "beneficiary": {
      "address": "<string>",
      "memo": "<string>",
      "source": "declared"
    },
    "utxo": {
      "inputs": [
        {
          "address": "<string>",
          "amount": "0.0125",
          "txid": "<string>",
          "vout": 1
        }
      ],
      "outputs": [
        {
          "address": "<string>",
          "amount": "0.0125",
          "txid": "<string>",
          "vout": 1
        }
      ],
      "change_output_indexes": [
        123
      ],
      "beneficiary_output_index": 123
    },
    "lightning": {},
    "warnings": [
      "declared_originator_not_an_input"
    ],
    "not_applicable_reason": "LIGHTNING_NO_PAYEE_IDENTIFIER"
  }
}

授权

x-api-key

string

header

必填

您的应用 API 密钥，可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于 IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP 列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

路径参数

transaction_id

string<uuid>

必填

拥有该转账的 Didit 稳定交易 UUID。

请求体

application/json

请恰好提供以下之一：payment_txn_id（完成）、action=cancel、action=resend、带有 compliance_email 的 action=update_compliance_email、带有 wallet_address 的 action=update_originator_wallet，或带有 beneficiary_vasp 的 action=beneficiary_vasp。

payment_txn_id

string

链上交易哈希。要求该转账为处于 COMPLETED 状态的出向转账。

action

enum<string>

"cancel" 取消非终态转账。"resend" 对停留在 COUNTERPARTY_VASP_NOT_FOUND、COUNTERPARTY_VASP_NOT_REACHABLE 或 NOT_ENOUGH_COUNTERPARTY_DATA 状态的出向转账重新运行路由。"update_compliance_email" 替换该请求所发送到的合规邮箱（适用于处于这三种状态之一的出向转账）；之后发送 "resend"。"update_originator_wallet" 记录资金实际转出的钱包（wallet_address、memo）。"beneficiary_vasp" 由您自行指定处于上述状态之一的出向转账的交易对手 VASP（需要 beneficiary_vasp）：请求将被路由至该 VASP 并重新发送。

可用选项:

cancel,

resend,

update_compliance_email,

update_originator_wallet,

beneficiary_vasp

compliance_email

string<email>

当 action: update_compliance_email 时必填。保存为该笔转账的 beneficiary_data.counterparty_vasp_email：仅归属于该笔转账，不加入任何名录条目或联系人列表。

Maximum string length: 254

wallet_address

string

配合 action: update_originator_wallet：资金流出的钱包。当转账的 UTXO 输入已知时，必须是其中之一。

Maximum string length: 128

memo

string

配合 action: update_originator_wallet：该钱包在 memo 网络上的 memo 或 tag。可选。

Maximum string length: 256

beneficiary_vasp

string<uuid>

当 action=beneficiary_vasp 时必填：来自 GET /v3/travel-rule/vasps/ 的名录 VASP 的 id。您的选择优先于所有自动发现步骤，且绝不会被覆盖。

响应

已更新的转账。在执行 update_compliance_email 后，其状态保持不变，并保留 reason: email_undeliverable，直到下一次 resend。

所有权确认以及完成/取消 endpoint 返回的完整转账对象。当入站转账的钱包所有权未确认时，交易对手的 originator_data 和 beneficiary_data 会被掩码返回（保留每个单词的首字母；钱包、链以及 VASP 路由保持可读），且 data_masked 为 true。

uuid

string<uuid>

status

enum<string>

可用选项:

AWAITING_COUNTERPARTY,

ON_HOLD,

COMPLETED,

FINISHED,

CANCELLED,

EXPIRED,

COUNTERPARTY_MISMATCHED_DATA,

COUNTERPARTY_VASP_NOT_FOUND,

COUNTERPARTY_VASP_NOT_REACHABLE,

UNCONFIRMED_OWNERSHIP,

COUNTERPARTY_VASP_GENERAL_DECLINE,

NOT_ENOUGH_COUNTERPARTY_DATA,

NOT_APPLICABLE

direction

enum<string>

可用选项:

INBOUND,

OUTBOUND

rail

enum<string> | null

转账路由所使用的通道，如果未选择通道（例如低于阈值、交易对手为自托管钱包、充值后登记或无触达的交易对手），则为 null。INTERNAL 表示双方均为 Didit 应用；EMAIL 表示通过电子邮件发送的提取链接触达交易对手。TEST_VASP 表示由 Didit Test VASP 响应沙盒转账。在 GTR、VERIFYVASP 和 SYGNA 上，Didit 会从网络响应中读取交易对手的回答，或每 5 分钟轮询一次。TRUST 仅支持发送，因此 TRUST 转账将一直保持 AWAITING_COUNTERPARTY 状态直至过期。网络通道仅在您已关联该网络自身会员资格时使用。它在交易创建返回后选定，因此在该响应中为 null。

可用选项:

INTERNAL,

TRP,

GTR,

TRUST,

VERIFYVASP,

SYGNA,

EMAIL,

TEST_VASP,

null

protocol

string | null

ivms_version

string

示例:

"ivms101.2023"

required

boolean

ownership_confirmed

boolean | null

deadline_at

string<date-time> | null

timeline

object[]

Show child attributes

counterparty_vasp

object | null

Show child attributes

originator_data

object

汇款人方。对于入账转账，在所有权确认之前，交易对手的值将被掩码遮盖。

beneficiary_data

object

收款人方。对于入账转账，在确认所有权之前，交易对手的值将被遮蔽。

name_match

object · null · null

决定转账的姓名比对结果，在运行比对前为 null。在当事方被脱敏期间，以及在 INTERNAL 交易另一方客户的副本上，transfer_name、compared_name、matched_names 和 mismatched_names 将被隐藏。score 和 matched 可能会不一致：matched 遵循严格程度规则，score 则是两个全名之间的相似度。

Show child attributes

data_match

object | null

转账当事方数据与对方已知的钱包持有人信息之间的逐字段比对。该项仅指明字段和结果，绝不包含具体值，因此在交易对手数据被脱敏的同时仍保持可读性。在执行比对前为 null。

Show child attributes

mismatched_fields

string[]

data_match.mismatched_fields 的快捷方式。无差异时为空。

data_unmasked

object | null

交易对手数据解除掩码时刻的审计记录。当数据仍处于掩码状态时以及出站转账时为 null。

Show child attributes

data_masked

boolean

在此响应中交易对手的个人数据被遮蔽时为 True。

created_at

string<date-time>

delivery

object | null

此转账应发送给对方的最新消息所处的状态。当转账从未需要发送消息时（例如低于 threshold_amount、声明的自托管钱包或 sunrise 注册）为 null。

Show child attributes

discovery

object[]

Didit 查找交易对手的方式，每个运行的步骤对应一个条目。未运行发现流程时为空，例如对于入站转账。

Show child attributes

reason

string

COUNTERPARTY_VASP_NOT_FOUND 或 COUNTERPARTY_VASP_NOT_REACHABLE 转账受阻的原因；任何其他状态下为 ""。首先由失败的投递决定（仅适用于 COUNTERPARTY_VASP_NOT_REACHABLE）：email_undeliverable（邮件服务商拒绝了合规邮件，且没有可尝试的地址：发送时、发送提醒时或后续报告为永久退信）或 delivery_failed（负责投递的通道彻底失败：网络通道拒绝了消息或重试次数耗尽、TRP 身份主机未应答，或交易对手的 TRP 主机不接受查询）。否则由 discovery 追踪记录决定：awaiting_end_user（没有任何步骤指定 Didit 可触达的交易对手）、directory_match_no_route（某步骤指定了名录中的 VASP，但该 VASP 没有可用路由）、picked_member_without_proven_wallet（终端用户选择的 Didit 客户尚未证明对该钱包的控制权），或者在追踪记录未提供其他原因时的 no_directory_match。重新发送后转账会继续推进，因此该原因将被清除。参见转账受阻的原因。

next_actions

object[]

推进转账的操作；除 COUNTERPARTY_VASP_NOT_FOUND 或 COUNTERPARTY_VASP_NOT_REACHABLE 之外的任何状态均返回 []。email_undeliverable 提供 update_compliance_email，然后提供 resend。delivery_failed 提供 resend。发现原因提供 select_counterparty_vasp、declare_self_hosted、add_vasp_hint 和 resend。

Show child attributes

chain_details

object

当转账涉及的不止是一个地址向另一个地址付款时，该交易所在区块链对其两个钱包的命名方式。对于账户模型区块链上的转账（EVM、Solana、Tron），由于两个地址本身就是钱包，因此该字段为空（{}）。匹配、路由和地址簿会优先从此字段读取钱包信息。

Show child attributes

最后修改于 2026年11月7日