> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# API Travel Rule: finalitzar, reenviar i actualitzar
> Tanca una transferència Travel Rule amb el seu hash on-chain, cancel·la-la o reenvia-la, o registra la cartera de la qual han sortit els fons a Didit.
Indicació de l'API d'accions de transferència de Travel Rule
Copia el prompt al porta-retalls
\
\`Act on an existing Travel Rule transfer: report the on-chain hash to finish it, cancel it, re-run counterparty routing, replace a refused compliance email, or record the wallet the funds left from.
Endpoint:
PATCH https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/
Authentication:
Use the x-api-key header with my Didit API key. {transaction_id} is the Didit transaction uuid.
Four mutually exclusive bodies:
1\. Finish (close out after broadcasting on-chain):
\{"payment_txn_id": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060"}
\- Requires an OUTBOUND transfer in COMPLETED status - otherwise 409.
\- Moves the transfer (and its INTERNAL-rail counterpart, if any) to FINISHED and stores the hash on the transaction.
\- Over GTR, VerifyVASP or Sygna Bridge, the network learns the hash after the response, with retries (see delivery below).
\- On the TRP rail, Didit also posts the hash to the counterparty's confirmation callback.
2\. Cancel:
\{"action": "cancel"}
\- Allowed from any non-terminal status; moves the transfer (and its INTERNAL-rail counterpart, if any) to CANCELLED.
\- From a terminal status (FINISHED, CANCELLED, EXPIRED) it returns 409.
\- On an outbound TRP transfer, Didit also sends a cancellation to the counterparty.
\- Over GTR, VerifyVASP or Sygna Bridge, the network is told after the response, with retries.
3\. Resend (re-run the routing ladder):
\{"action": "resend"}
\- Allowed only on an OUTBOUND transfer in COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, or NOT_ENOUGH_COUNTERPARTY_DATA - otherwise 409.
\- Resets the deadline and re-runs routing; a transfer whose destination wallet was declared unhosted moves to UNCONFIRMED_OWNERSHIP.
\- First give Didit a route, for example by registering the destination wallet in your address book (same chain as the transfer, or a blank chain) with the counterparty's travel_address (TRP carries BTC, ETH, and USDC on a named network), or by adding a compliance contact for the counterparty's directory entry with POST /v3/travel-rule/counterparty-contacts/, then resend.
\- Resend reuses the transfer's beneficiary_data, which you cannot change after creation except for the compliance email (body 4), so submit a new transaction to send different beneficiary data.
\- A previously recorded blockchain-analytics attribution is reused - no new lookup, no new charge.
\- Discovery runs again from the first step (internal address book, wallet attribution, network lookup, your VASP hint, then the end user); the transfer's "discovery" list shows what each step found.
\- Queued, not run inside the request: the response shows the transfer back in AWAITING_COUNTERPARTY with a "resend queued" timeline entry, and the outcome arrives as a travel_rule.status.updated webhook. A resend sent while an earlier attempt is still running is sent once that attempt settles.
\- If routing still resolves nothing, the transfer lands back in COUNTERPARTY_VASP_NOT_FOUND.
4\. Update the compliance email (the fix for reason email_undeliverable):
\{"action": "update_compliance_email", "compliance_email": "desk@bene-casp.example"}
\- Allowed only on an OUTBOUND transfer in COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, or NOT_ENOUGH_COUNTERPARTY_DATA - otherwise 409.
\- A missing or malformed compliance_email returns 400.
\- Stores the address as this transfer's beneficiary_data.counterparty_vasp_email; it belongs to this transfer only and joins no directory entry or contact list.
\- The status does not change and the timeline gains "compliance email updated". The transfer keeps reason email_undeliverable until you send {"action": "resend"}, which sends the request to the new address.
4\. Update the originator wallet (the wallet the funds actually left from):
\{"action": "update_originator_wallet", "wallet_address": "bc1q...", "memo": ""}
\- Outbound transfers only (an inbound transfer -> 409), and never a CANCELLED or EXPIRED one (-> 409).
\- Use it when a withdrawal is broadcast from another address than the one declared, typically a UTXO withdrawal spending whichever addresses held the coins. When the transfer's UTXO inputs are known, wallet_address must be one of them (-> 400 otherwise).
\- Changes the record only: nothing is sent to the counterparty again and the status stays. chain_details.originator becomes the new wallet with source "updated", the timeline records the previous and the new wallet, and the INTERNAL-rail counterpart is updated the same way.
5\. Name the counterparty (when discovery could not):
\{"action": "beneficiary_vasp", "beneficiary_vasp": ""}
\- The id comes from GET /v3/travel-rule/vasps/.
\- Allowed only for an outbound transfer in COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, or NOT_ENOUGH_COUNTERPARTY_DATA - otherwise 409.
\- Routes the transfer to that VASP and sends it again; automatic discovery never overrides your choice.
\- 400 if beneficiary_vasp is missing or not a valid id, 404 if no directory entry has that id.
What to read from the response:
\- The full transfer object: status, rail, direction, ownership_confirmed, deadline_at, timeline, counterparty_vasp, delivery, discovery, reason, next_actions.
\- delivery: the latest message the transfer owes the other side - kind (SEND, ANSWER, TXID, CANCEL, POLL), status (QUEUED, SENDING, RETRYING, DELIVERED, FAILED), rail, attempts, last_error, next_attempt_at, delivered_at. Failures a network may recover from are retried after 30 s, 2, 10, 30 and 60 minutes; when a first message fails for good the transfer moves to COUNTERPARTY_VASP_NOT_REACHABLE. null when the transfer never owed a message.
\- reason and next_actions say why a COUNTERPARTY_VASP_NOT_FOUND or COUNTERPARTY_VASP_NOT_REACHABLE transfer is stuck and what moves it on: email_undeliverable offers update_compliance_email then resend, delivery_failed offers resend, and a discovery reason offers select_counterparty_vasp, declare_self_hosted, add_vasp_hint and resend. Both are empty for any other status, so they clear once a resend moves the transfer on.
Order of operations for outbound transfers:
submit transaction -> wait for travel_rule.status == "COMPLETED" -> broadcast on-chain -> PATCH with payment_txn_id -> FINISHED.
Never broadcast before COMPLETED.
A transfer sent over TRUST cannot reach COMPLETED, because TRUST sends back nothing Didit can read; it stays AWAITING_COUNTERPARTY until it expires. Over GTR, VerifyVASP and Sygna Bridge, Didit reads the counterparty's answer from the network.
If the message cannot be delivered, the transfer moves to COUNTERPARTY_VASP_NOT_REACHABLE instead.
Failure modes:
\- 400 - the body has none of payment_txn_id or a supported action, update_compliance_email has a missing or malformed compliance_email, or a wallet_address or memo the transfer's chain cannot carry.
\- 409 - action not allowed from the transfer's current status or direction (see the per-action rules above).
\- 400 - action=beneficiary_vasp without a valid beneficiary_vasp.
\- 404 - unknown transaction, no Travel Rule transfer attached, or (action=beneficiary_vasp) no directory entry has that id.
Full guide: /transaction-monitoring/travel-rule#sending-a-transfer and /transaction-monitoring/travel-rule#why-a-transfer-is-stuck.`
\
Enganxa a
## OpenAPI
````yaml ca/openapi-25.json PATCH /v3/transactions/{transaction_id}/travel-rule/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/transactions/{transaction_id}/travel-rule/:
patch:
tags:
- Travel Rule
summary: >-
Finalitzar, cancel·lar, reenviar o actualitzar la cartera ordenant d'una
transferència de la Travel Rule
description: >-
Proporciona `payment_txn_id` per informar del hash on-chain i passar una
transferència sortint COMPLETED a FINISHED (la seva contrapart del rail
INTERNAL també passa a FINISHED), `{"action": "cancel"}` per cancel·lar
una transferència no terminal, o `{"action": "resend"}` per tornar a
encaminar una transferència sortint blocada a
COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o
NOT_ENOUGH_COUNTERPARTY_DATA (millora primer les dades de la contrapart,
p. ex. afegeix una travel_address a l'entrada de la cartera de
destinació). resend només s'aplica a transferències sortints.
`{"action": "update_compliance_email", "compliance_email":
"desk@example.com"}` substitueix el correu de compliment d'una
transferència sortint en un d'aquests tres estats, la solució per a
`reason: email_undeliverable`: l'estat no canvia i el següent `resend`
envia la sol·licitud a aquesta adreça. Un reenviament s'encua, no
s'executa dins de la sol·licitud: la resposta mostra la transferència de
nou a AWAITING_COUNTERPARTY amb una entrada de `resend queued` a la
cronologia i un `delivery` encuat, i la informació sobre on ha anat
arriba com un webhook `travel_rule.status.updated`. Quan la
transferència s'ha fet a través de GTR, VerifyVASP o Sygna Bridge, la
xarxa rep el hash on-chain o la cancel·lació després de la resposta, amb
reintents; `delivery` mostra l'estat d'aquest missatge. `{"action":
"update_originator_wallet", "wallet_address": "..."}` registra la
cartera des d'on han sortit realment els fons en una transferència
sortint, per exemple l'adreça des d'on s'ha difós una retirada UTXO en
lloc de la cartera principal declarada. Només modifica el registre: no
es torna a enviar res a la contrapart i l'estat es manté. L'ordenant
passa a ser `chain_details.originator` amb `source: updated`, el canvi
s'afegeix a la `timeline` amb la cartera anterior i la nova, i la
contrapart del rail INTERNAL de la transferència s'actualitza de la
mateixa manera. `{"action": "beneficiary_vasp", "beneficiary_vasp":
""}` indica la contrapart manualment quan el
descobriment no ho ha pogut fer, en una transferència sortint a
COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o
NOT_ENOUGH_COUNTERPARTY_DATA: la transferència s'encamina cap a aquest
VASP i es torna a enviar.
operationId: patchTravelRuleTransfer
parameters:
- name: transaction_id
in: path
required: true
description: UUID de transacció estable de Didit que posseeix la transferència.
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TravelRuleTransferPatchRequest'
examples:
Finish:
value:
payment_txn_id: 0xchainhash
Cancel:
value:
action: cancel
Resend:
value:
action: resend
Update compliance email:
value:
action: update_compliance_email
compliance_email: desk@example.com
Update originator wallet:
value:
action: update_originator_wallet
wallet_address: bc1qOriginatorInputAddress01
Name the counterparty:
value:
action: beneficiary_vasp
beneficiary_vasp: 9f1c2b34-5d6e-4f70-8a91-b2c3d4e5f607
responses:
'200':
description: >-
La transferència actualitzada. Després de `update_compliance_email`,
el seu estat no canvia i manté `reason: email_undeliverable` fins al
següent `resend`.
content:
application/json:
schema:
$ref: '#/components/schemas/TravelRuleTransferDetail'
'400':
description: >-
No s'ha proporcionat ni payment_txn_id ni una acció admesa, falta
`compliance_email` o no és una adreça de correu electrònic a
`update_compliance_email`, o bé, per a `update_originator_wallet`,
falta wallet_address, la cartera o el memo no són compatibles amb la
cadena de la transferència, o la cartera no és una de les entrades
UTXO de la transferència, o bé falta `beneficiary_vasp` o no és un
identificador de VASP del directori vàlid.
content:
application/json:
examples:
No action:
value:
detail:
- >-
Provide payment_txn_id, action=cancel, action=resend,
action=beneficiary_vasp, action=update_originator_wallet
or action=update_compliance_email.
Invalid compliance email:
value:
compliance_email:
- Enter a valid email address.
'404':
description: >-
Transacció desconeguda, la transacció no té cap transferència de
Travel Rule o (acció `beneficiary_vasp`) cap entrada del directori
té aquest id.
'409':
description: >-
La transferència no està en un estat que permeti aquesta operació
(p. ex., no està en COMPLETED/sortint per a finalitzar, ja és
terminal per a cancel·lar, o no és una transferència sortint en un
estat reenviable per a reenviar). `update_compliance_email` respon
`409` per a una transferència entrant, i per a una de sortint que no
estigui a COUNTERPARTY_VASP_NOT_FOUND,
COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA.
`update_originator_wallet` respon `409` per a una transferència
entrant, cancel·lada o caducada. `beneficiary_vasp` respon `409`
tret que la transferència sigui sortint i estigui a
COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o
NOT_ENOUGH_COUNTERPARTY_DATA.
content:
application/json:
examples:
Cancel from a terminal status:
value:
detail: Transfer is already in a terminal state.
Resend not allowed:
value:
detail: Transfer cannot be resent from its current state.
Finish not allowed:
value:
detail: >-
Transfer must be an outbound transfer in COMPLETED status
to finish.
Compliance email cannot change:
value:
detail: >-
The compliance email of this transfer cannot change from
its current state.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
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"}'
- lang: python
label: Python
source: |-
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)
- lang: javascript
label: Node.js
source: >-
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);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.UpdateTransfer(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleTransferPatchRequest{\n\tPaymentTxnID: didit.String(\"0xchainhash\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
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);
- lang: php
label: PHP
source: >-
transactions->travelRule->updateTransfer('11111111-2222-3333-4444-555555555555',
[
'payment_txn_id' => '0xchainhash',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
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
- lang: csharp
label: .NET
source: >-
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));
components:
schemas:
TravelRuleTransferPatchRequest:
type: object
description: >-
Proporciona exactament un d'aquests valors: payment_txn_id (finalitzar),
action=cancel, action=resend, action=update_compliance_email amb
compliance_email, action=update_originator_wallet amb wallet_address, o
action=beneficiary_vasp amb beneficiary_vasp.
properties:
payment_txn_id:
type: string
description: >-
El hash de la transacció on-chain. Requereix que la transferència
sigui una transferència sortint en estat COMPLETED.
action:
type: string
enum:
- cancel
- resend
- update_compliance_email
- update_originator_wallet
- beneficiary_vasp
description: >-
"cancel" cancel·la una transferència que no es troba en un estat
terminal. "resend" torna a executar l'encaminament d'una
transferència de sortida bloquejada en l'estat
COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o
NOT_ENOUGH_COUNTERPARTY_DATA. "update_compliance_email" substitueix
el correu electrònic de compliment al qual s'envia la sol·licitud,
en una transferència de sortida en un d'aquests tres estats; envia
"resend" després. "update_originator_wallet" registra la cartera des
d'on han sortit realment els fons (`wallet_address`, `memo`).
"beneficiary_vasp" designa el VASP contrapart tu mateix (requereix
`beneficiary_vasp`) per a una transferència de sortida en un
d'aquests estats: s'encamina a aquest VASP i es torna a enviar.
compliance_email:
type: string
format: email
maxLength: 254
description: >-
Obligatori amb `action: update_compliance_email`. Es desa com el
`beneficiary_data.counterparty_vasp_email` d'aquesta transferència:
pertany únicament a aquesta transferència i no s'afegeix a cap
entrada de directori ni a cap llista de contactes.
wallet_address:
type: string
maxLength: 128
description: >-
Amb `action: update_originator_wallet`: la cartera des d'on han
sortit els fons. Quan es coneixen les entrades UTXO de la
transferència, ha de ser una d'elles.
memo:
type: string
maxLength: 256
description: >-
Amb `action: update_originator_wallet`: el memo o l'etiqueta de la
cartera en una xarxa amb memo. Opcional.
beneficiary_vasp:
type: string
format: uuid
description: >-
Obligatori amb action=beneficiary_vasp: l'`id` d'un VASP del
directori, obtingut de `GET /v3/travel-rule/vasps/`. La teva
selecció té prioritat sobre qualsevol pas de descobriment automàtic,
que mai la sobreescriurà.
TravelRuleTransferDetail:
type: object
description: >-
Objecte de transferència complet retornat pels endpoints de confirmació
de titularitat i de finalització/cancel·lació. Mentre la titularitat de
la cartera d'una transferència entrant no estigui confirmada, els camps
`originator_data` i `beneficiary_data` de la contrapart es retornen
emmascarats (es manté la primera lletra de cada paraula; la cartera, la
cadena i l'encaminament del VASP continuen sent llegibles) i
`data_masked` és true.
properties:
uuid:
type: string
format: uuid
status:
type: string
enum:
- 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:
type: string
enum:
- INBOUND
- OUTBOUND
rail:
type: string
nullable: true
enum:
- INTERNAL
- TRP
- GTR
- TRUST
- VERIFYVASP
- SYGNA
- EMAIL
- TEST_VASP
- null
description: >-
El rail pel qual s'ha encaminat la transferència, o null quan no se
n'ha seleccionat cap (per exemple, per sota del llindar, una cartera
autoallotjada de la contrapart, un registre posterior al dipòsit o
cap contrapart accessible). INTERNAL significa que ambdues parts són
aplicacions de Didit; EMAIL significa que s'ha contactat amb la
contrapart mitjançant un enllaç de recollida enviat per correu
electrònic. TEST_VASP significa que el Didit Test VASP ha respost a
la transferència de sandbox. A través de GTR, VERIFYVASP i SYGNA,
Didit llegeix la resposta de la contrapart a partir de la resposta
de la xarxa o fent-ne un sondeig cada 5 minuts. TRUST només envia,
de manera que una transferència TRUST roman en AWAITING_COUNTERPARTY
fins que caduca. Un rail de xarxa només s'utilitza quan has
connectat la teva pròpia afiliació a aquesta xarxa. Es tria després
que la creació de la transacció retorni, de manera que és null en
aquesta resposta.
protocol:
type: string
nullable: true
ivms_version:
type: string
example: ivms101.2023
required:
type: boolean
ownership_confirmed:
type: boolean
nullable: true
deadline_at:
type: string
format: date-time
nullable: true
timeline:
type: array
items:
type: object
properties:
status:
type: string
at:
type: string
format: date-time
detail:
type: string
name_match:
allOf:
- $ref: '#/components/schemas/TravelRuleNameMatch'
nullable: true
description: >-
La comparació de noms que aquesta entrada ha decidit, al
costat de `detail`. Absent en les entrades que no han comparat
cap nom.
reason:
type: string
description: >-
Present només a l'entrada d'una transició causada per un
lliurament fallit: `email_undeliverable` o `delivery_failed`,
el valor que informa el camp `reason` de la transferència.
counterparty_vasp:
type: object
nullable: true
properties:
name:
type: string
lei:
type: string
dd_score:
type: integer
description: >-
Puntuació de diligència deguda de 0 a 100, on un valor més alt
és millor. La mateixa escala que al directori de VASP.
dd_score_breakdown:
type: object
description: >-
Contribucions per component a dd_score, un objecte per component
tal com apareix al directori de VASP (jurisdiction,
verification, protocol, lei, history, essentials,
responsiveness), cadascun amb {points, max, reason, detail}. {}
fins que s'hagi avaluat la contrapart.
additionalProperties:
type: object
properties:
points:
type: number
description: Punts atorgats per a aquest component.
max:
type: integer
description: Nombre màxim de punts que pot atorgar aquest component.
reason:
type: string
description: Codi llegible per màquina del veredicte del component.
detail:
type: string
description: Motiu dels punts atorgats, llegible per a humans.
dd_assessed_at:
type: string
format: date-time
nullable: true
description: >-
Quan es va executar per darrera vegada l'avaluació de diligència
deguda. Null fins que s'hagi avaluat la contrapart.
originator_data:
type: object
description: >-
Part ordenant. Per a una transferència entrant, els valors de la
contrapart s'emmascaren fins que se'n confirmi la titularitat.
beneficiary_data:
type: object
description: >-
Part beneficiària. Per a una transferència entrant, els valors de la
contrapart s'emmascaren fins que es confirmi la titularitat.
name_match:
allOf:
- $ref: '#/components/schemas/TravelRuleNameMatch'
nullable: true
description: >-
La comparació de noms que ha decidit la transferència, o null fins
que se n'hagi executat una. Mentre les parts estan emmascarades, i a
la còpia de l'altre client d'un intercanvi INTERNAL,
`transfer_name`, `compared_name`, `matched_names` i
`mismatched_names` s'oculten. `score` i `matched` poden discrepar:
`matched` segueix l'estrictesa, `score` és la similitud dels dos
noms complets.
data_match:
$ref: '#/components/schemas/TravelRuleDataMatch'
mismatched_fields:
type: array
items:
type: string
description: >-
Drecera per a `data_match.mismatched_fields`. Buit quan no hi ha cap
diferència.
data_unmasked:
$ref: '#/components/schemas/TravelRuleDataUnmasked'
data_masked:
type: boolean
description: >-
Cert mentre les dades personals de la contrapart estiguin
emmascarades en aquesta resposta.
created_at:
type: string
format: date-time
delivery:
nullable: true
allOf:
- $ref: '#/components/schemas/TravelRuleDelivery'
description: >-
Estat en què es troba l'últim missatge que aquesta transferència deu
a l'altra part. És nul quan la transferència mai no n'ha degut cap
(per exemple, per sota de `threshold_amount`, una cartera
autoallotjada declarada o un registre de sunrise).
discovery:
type: array
description: >-
Com Didit ha cercat la contrapart, una entrada per cada pas que s'ha
executat. Buit quan no s'ha executat cap descobriment, per exemple
en una transferència entrant.
items:
$ref: '#/components/schemas/TravelRuleDiscoveryStep'
reason:
type: string
description: >-
Per què una transferència `COUNTERPARTY_VASP_NOT_FOUND` o
`COUNTERPARTY_VASP_NOT_REACHABLE` està encallada; `""` per a
qualsevol altre estat. Un lliurament fallit ho determina primer,
només a `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (el
proveïdor de correu ha refusat el correu electrònic de compliment i
no queda cap adreça per provar: quan s'ha enviat, en un recordatori
o com un rebot permanent notificat més tard) o `delivery_failed` (el
canal que l'estava lliurant ha fallat definitivament: un canal de
xarxa ha refusat el missatge o s'ha quedat sense reintents, un host
d'identitat `TRP` no ha respost o l'host `TRP` de la contrapart no
ha acceptat la consulta). En cas contrari, el rastreig de
`discovery` ho determina: `awaiting_end_user` (cap pas ha indicat
una contrapart a la qual Didit pugui arribar),
`directory_match_no_route` (un pas ha indicat un VASP del directori
que no té ruta), `picked_member_without_proven_wallet` (l'usuari
final ha triat un client de Didit que no ha demostrat el control de
la cartera) o `no_directory_match` quan el rastreig no dóna cap
altre motiu. Un reenviament fa avançar la transferència, de manera
que el motiu s'esborra. Consulta [Per què una transferència està
encallada](/ca/transaction-monitoring/travel-rule#per-què-una-transferència-està-bloquejada).
next_actions:
type: array
description: >-
Què fa avançar la transferència; `[]` per a qualsevol estat excepte
`COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE`.
`email_undeliverable` ofereix `update_compliance_email` i després
`resend`. `delivery_failed` ofereix `resend`. Un motiu de
descobriment ofereix `select_counterparty_vasp`,
`declare_self_hosted`, `add_vasp_hint` i `resend`.
items:
$ref: '#/components/schemas/TravelRuleNextAction'
chain_details:
$ref: '#/components/schemas/TravelRuleChainDetails'
TravelRuleNameMatch:
type: object
nullable: true
description: >-
La comparació de noms que ha decidit la transferència, o null fins que
se n'hagi executat una. Mentre les parts estan emmascarades, i a la
còpia de l'altre client d'un intercanvi INTERNAL, `transfer_name`,
`compared_name`, `matched_names` i `mismatched_names` s'oculten. `score`
i `matched` poden discrepar: `matched` segueix l'estrictesa, `score` és
la similitud dels dos noms complets.
properties:
score:
type: integer
minimum: 0
maximum: 100
description: >-
Similitud dels dos noms complets, de 0 a 100. 0 quan algun dels noms
està en blanc.
matched:
type: boolean
description: >-
Si els noms compleixen `strictness`. El resultat de la transferència
segueix `data_match`, que compara cada camp, de manera que una
transferència pot ser COUNTERPARTY_MISMATCHED_DATA mentre això sigui
cert.
method:
type: string
enum:
- none
- exact_token
- token_subset
- token_containment
- sequence_ratio
description: >-
Com s'ha decidit `matched`: cap (`NONE`), exact_token (`STRICT`),
token_subset (`DEFAULT`), token_containment (`CONTAINS`) o
sequence_ratio (`FUZZY`).
strictness:
type: string
enum:
- NONE
- STRICT
- CONTAINS
- DEFAULT
- FUZZY
compared_with:
type: string
enum:
- wallet_holder
- counterparty_vasp
description: >-
wallet_holder: el titular registrat per a la cartera.
counterparty_vasp: el nom que la contrapart ha indicat a la pàgina
de resposta per correu electrònic, o la resposta del VASP de prova
de Didit a sandbox.
transfer_name:
type: string
description: El nom que figura a la transferència.
compared_name:
type: string
description: El nom amb què s'ha comparat.
matched_names:
type: array
items:
type: string
description: Paraules de `transfer_name` trobades a `compared_name`.
mismatched_names:
type: array
items:
type: string
description: >-
Paraules de `transfer_name` que falten a `compared_name` i, tot
seguit, paraules de `compared_name` que falten a `transfer_name`.
TravelRuleDataMatch:
type: object
nullable: true
description: >-
Comparació camp per camp de les dades de les parts de la transferència
amb el que l'altra part sap sobre el titular de la cartera. Nomena camps
i resultats, mai valors, de manera que continua sent llegible mentre les
dades de la contrapart estan emmascarades. Null fins que s'executi una
comparació.
properties:
matched:
type: boolean
description: Cert quan cap camp comparat difereix.
mismatched_fields:
type: array
items:
type: string
enum:
- name
- date_of_birth
- address
- account
description: Els camps que difereixen.
fields:
type: object
description: >-
Una entrada per camp comparat per al tipus d'entitat de la part
(`name`, `date_of_birth`, `address`, `account`; una empresa no té
`date_of_birth`).
additionalProperties:
type: object
properties:
result:
type: string
enum:
- matched
- mismatched
- not_compared
description: >-
`not_compared` quan la regla és `NONE` o una de les dues parts
no té cap valor per al camp.
strictness:
type: string
enum:
- NONE
- STRICT
- CONTAINS
- DEFAULT
- FUZZY
TravelRuleDataUnmasked:
type: object
nullable: true
description: >-
Registre d'auditoria del moment en què es van desenmascarar les dades de
la contrapart. És null mentre les dades continuïn emmascarades, així com
per a transferències sortints.
properties:
at:
type: string
format: date-time
reason:
type: string
enum:
- ownership_confirmed
- wallet_proof
- address_book_match
- own_verified_wallet
- inquiry_approved
- known_payment_method
- travel_address
description: >-
Què va confirmar la titularitat: ownership_confirmed (la teva
confirmació mitjançant la consola o l'API), wallet_proof (una prova
de cartera al widget, o una transferència entrant INTERNAL,
establerta quan es crea), address_book_match (una cartera de la
llibreta d'adreces verificada), own_verified_wallet (la pròpia
cartera verificada del teu usuari), inquiry_approved (la teva
aprovació d'una consulta TRP entrant o un missatge GTR o Sygna),
known_payment_method (una cartera amb la qual el teu usuari ja ha
pagat) o travel_address (la Travel Address per cartera que va donar
nom a la cartera).
actor:
type: string
description: >-
Qui ho ha confirmat: el correu electrònic de l'usuari de la consola
o l'etiqueta de la clau d'API. En blanc per a una decisió
automàtica.
TravelRuleDelivery:
type: object
description: >-
Estat en què es troba l'últim missatge que la transferència deu a
l'altra part. Didit contacta amb la contrapart un cop retornada la
sol·licitud que ha creat o modificat la transferència, de manera que
aquest objecte indica si el missatge s'ha lliurat: en cua, enviant-se,
esperant per reintentar després d'un error, lliurat o fallit. Una
fallada de la qual la xarxa encara es pot recuperar (sense resposta a
temps, connexió fallida, HTTP `408`, `429` o `5xx`) es reintenta al cap
de 30 segons, 2 minuts, 10 minuts, 30 minuts i 1 hora. Quan un primer
missatge (`kind: SEND`) falla definitivament, perquè la xarxa l'ha
rebutjat o perquè el sisè intent també ha fallat, la transferència passa
a `COUNTERPARTY_VASP_NOT_REACHABLE` amb `last_error` a la seva
`timeline`; qualsevol altre missatge que falli definitivament s'anota a
la `timeline`. L'`status` de la transferència continua sent la font de
referència de l'intercanvi en si.
required:
- kind
- status
- rail
- attempts
- last_error
- next_attempt_at
- delivered_at
properties:
kind:
type: string
enum:
- SEND
- ANSWER
- TXID
- CANCEL
- POLL
description: >-
Què transmet el missatge. `SEND`: el primer missatge de la
transferència a la contrapart (sortint; el canal es tria quan
s'envia). `ANSWER`: la teva acceptació o rebuig, que es deu a la
xarxa que ho ha sol·licitat (entrant). `TXID`: el hash de la
transacció on-chain, un cop finalitzis la transferència. `CANCEL`:
la cancel·lació, un cop la cancel·lis. `POLL`: una consulta d'estat
a una xarxa que n'ofereixi una, repetida cada 5 minuts mentre la
transferència espera la contrapart.
status:
type: string
enum:
- QUEUED
- SENDING
- RETRYING
- DELIVERED
- FAILED
description: >-
`QUEUED`: esperant per enviar-se. `SENDING`: hi ha un intent en
curs. `RETRYING`: un intent ha fallat i el següent s'executarà a
`next_attempt_at`. `DELIVERED`: l'altra part ha rebut el missatge.
`FAILED`: l'altra part l'ha rebutjat o el darrer intent ha fallat.
rail:
type: string
enum:
- INTERNAL
- TRP
- GTR
- TRUST
- VERIFYVASP
- SYGNA
- EMAIL
- ''
description: >-
El rail que transporta el missatge. Buit fins que Didit n'hagi triat
un per a un primer missatge.
attempts:
type: integer
minimum: 0
description: >-
Intents realitzats fins ara per a aquest missatge. Un missatge que
no sigui un sondeig d'estat s'intenta com a màxim 6 vegades.
last_error:
type: string
description: >-
El tipus d'error que ha afectat l'últim intent, `""` quan no n'hi ha
hagut cap: per exemple `email undeliverable`, `trp identity endpoint
unreachable` o `trp transfer inquiry delivery failed`. Mai no conté
la resposta de la contrapart mateixa, que roman al `timeline` de la
transferència.
Quan GTR respon amb un error, s'hi inclouen el seu propi codi
d'estat i missatge. Els cossos de resposta no s'inclouen mai.
example: email undeliverable
next_attempt_at:
type: string
format: date-time
nullable: true
description: >-
Quan s'executa el següent intent mentre el missatge està en estat
`QUEUED` o `RETRYING`.
delivered_at:
type: string
format: date-time
nullable: true
description: Quan l'altra part va rebre el missatge.
TravelRuleDiscoveryStep:
type: object
description: >-
Un pas de la detecció de la contrapart que Didit ha executat per a una
transferència sortint, en l'ordre en què els ha executat. El primer pas
que anomena un VASP amb una ruta finalitza la cadena.
properties:
step:
type: string
enum:
- internal_address_book
- wallet_attribution
- network_lookup
- customer_hint
- end_user
description: >-
`internal_address_book`: un altre client de Didit que ha demostrat
el control de la cartera de destinació. `wallet_attribution`:
l'atribució d'analítica blockchain de la cartera. `network_lookup`:
una xarxa que pot indicar quin VASP té l'adreça. `customer_hint`: el
nom del VASP, LEI o jurisdicció que has enviat a `beneficiary_data`.
`end_user`: la contrapart que l'usuari final (o tu) ha triat, o la
sol·licitud per triar-ne una.
outcome:
type: string
enum:
- match
- miss
- skipped
description: >-
`match`: el pas ha indicat una contrapart. `miss`: s'ha executat i
no n'ha trobat cap. `skipped`: no s'ha pogut executar, i `reason`
n'explica el motiu.
reason:
type: string
description: >-
Motiu llegible per màquina, `""` en cas de coincidència:
`no_proven_internal_wallet`, `attribution_disabled`,
`already_attributed`, `no_attributed_entity`,
`directory_match_no_route`, `gtr_address_lookup_runs_on_dispatch`,
`no_membership`, `network_switched_off`,
`no_network_address_lookup`, `no_directory_match`,
`awaiting_end_user` o `picked_member_without_proven_wallet`.
vasp:
type: string
format: uuid
nullable: true
description: El VASP del directori que ha indicat el pas, si n'ha indicat algun.
rail:
type: string
nullable: true
description: El rail que arriba a aquesta contrapart, quan el pas n'ha trobat un.
at:
type: string
format: date-time
TravelRuleNextAction:
type: object
description: >-
Un element que fa avançar una transferència
`COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE`.
Consulta [Per què una transferència està
bloquejada](/ca/transaction-monitoring/travel-rule#per-què-una-transferència-està-bloquejada).
properties:
action:
type: string
enum:
- select_counterparty_vasp
- declare_self_hosted
- add_vasp_hint
- update_compliance_email
- resend
description: >-
`select_counterparty_vasp`: l'usuari final tria el VASP de
destinació al widget de titularitat de la cartera, o fas un PATCH
amb `action=beneficiary_vasp`. `declare_self_hosted`: l'usuari final
declara que la cartera és autoallotjada al widget. `add_vasp_hint`:
indica a Didit qui és la contrapart, amb un nom de VASP, LEI o
Travel Address (per exemple, un `travel_address` a l'entrada de la
llibreta d'adreces de la cartera de destinació), i després torna a
enviar. `update_compliance_email` i `resend` són valors d'`action`
de `PATCH /v3/transactions/{transaction_id}/travel-rule/`: torna a
proporcionar el correu electrònic de compliment de la contrapart i
torna a executar l'encaminament.
url:
type: string
format: uri
description: >-
L'enllaç del widget de titularitat de la cartera, a
`select_counterparty_vasp` i `declare_self_hosted` mentre la
transferència té una sessió de widget oberta.
required:
- action
TravelRuleChainDetails:
type: object
description: >-
Com anomena la cadena de la transferència les seves dues carteres, quan
es tracta de més d'una adreça pagant-ne una altra. Buit (`{}`) per a una
transferència de cadena basada en comptes (EVM, Solana, Tron), on les
dues adreces són les carteres. La coincidència, l'encaminament i la
llibreta d'adreces llegeixen primer les carteres d'aquí.
properties:
chain:
type: string
description: >-
Cadena canònica, p. ex. `BTC`, `XRP` o `LIGHTNING` per a una
transferència Lightning.
shape:
type: string
enum:
- utxo
- memo
- lightning
originator:
$ref: '#/components/schemas/TravelRuleChainSide'
beneficiary:
$ref: '#/components/schemas/TravelRuleChainSide'
utxo:
type: object
description: >-
En una transferència UTXO: les entrades i sortides tal com s'han
emmagatzemat (imports com a cadenes decimals) i què ha llegit Didit
en cada sortida.
properties:
inputs:
type: array
items:
$ref: '#/components/schemas/TravelRuleUtxoEntry'
outputs:
type: array
items:
$ref: '#/components/schemas/TravelRuleUtxoEntry'
change_output_indexes:
type: array
items:
type: integer
description: Sortides que retornen el pagament a una adreça d'entrada.
beneficiary_output_index:
type: integer
nullable: true
description: >-
La sortida que paga al beneficiari; null quan no se'n pot
distingir cap.
lightning:
type: object
description: >-
En una transferència de Lightning: el que diu la sol·licitud de
pagament. Sempre `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`,
`bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` o
`unknown`); una factura BOLT11 afegeix `network`, `payee_node_id`,
`payment_hash`, `amount_msat`, `created_at` i `expires_at`; una
cadena BOLT12 afegeix `blinded_paths` i `payee_node_id`; un LNURL o
una Lightning Address inclou el seu `domain`. No es resol res a
través de la xarxa: la sol·licitud només es descodifica.
additionalProperties: true
warnings:
type: array
items:
type: string
enum:
- declared_originator_not_an_input
- declared_beneficiary_not_an_output
- beneficiary_output_ambiguous
- beneficiary_output_amount_differs
description: >-
Inconsistències d'UTXO que val la pena revisar: l'ordenant declarat
no és una entrada, el beneficiari declarat no és una sortida, no
s'ha pogut distingir cap sortida de beneficiari única o la sortida
del beneficiari paga un import diferent del que indica la
transacció.
not_applicable_reason:
type: string
enum:
- LIGHTNING_NO_PAYEE_IDENTIFIER
- LIGHTNING_BOLT12_BLINDED_PAYEE
- LIGHTNING_LNURL_NAMES_NO_PAYEE
description: >-
En una transferència sortint de Lightning la sol·licitud de pagament
de la qual no especifica cap beneficiari: per què la transferència
és `NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (la sol·licitud
no especifica cap node beneficiari, o no s'ha pogut descodificar),
`LIGHTNING_BOLT12_BLINDED_PAYEE` (l'oferta amaga el seu beneficiari
darrere de rutes cegues), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (un LNURL
especifica un servei, no un beneficiari). El mateix codi obre
l'última entrada de la `timeline` de la transferència.
TravelRuleChainSide:
type: object
description: >-
La cartera d'una de les parts tal com Didit l'ha resolt a partir de les
dades de la cadena.
properties:
address:
type: string
description: >-
La cartera. En una xarxa amb memo, l'adreça clàssica (una adreça X
d'XRP es divideix en la seva adreça clàssica i la seva etiqueta); a
Lightning, l'ID del node del beneficiari o l'adreça Lightning.
memo:
type: string
description: >-
L'etiqueta de destinació o nota que forma part de la cartera; `""`
quan no n'hi ha cap.
source:
type: string
enum:
- declared
- x_address
- largest_input
- only_non_change_output
- amount_match
- invoice_payee
- updated
description: >-
D'on prové la cartera: `declared` (la teva sol·licitud), `x_address`
(desglossada d'una adreça X d'XRP), `largest_input` (l'adreça
d'entrada UTXO que ha aportat més), `only_non_change_output`
(l'única sortida UTXO que no és canvi), `amount_match` (l'única
sortida UTXO que paga l'import de la transferència), `invoice_payee`
(el beneficiari que indica una sol·licitud de pagament de
Lightning), `updated` (establert més tard amb `action:
update_originator_wallet`).
TravelRuleUtxoEntry:
type: object
description: >-
Una entrada o sortida d'una transacció UTXO, tal com la va registrar la
cadena.
required:
- address
properties:
address:
type: string
maxLength: 128
amount:
type: string
nullable: true
description: >-
Cadena decimal en la unitat pròpia de la moneda (BTC, no satoshis).
Opcional.
example: '0.0125'
txid:
type: string
maxLength: 128
description: Opcional. La transacció que gasta un input.
vout:
type: integer
nullable: true
minimum: 0
description: Opcional. L'índex de la sortida que consumeix una entrada.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clau d'API de la teva aplicació, des de Developers -> API keys a la
Business Console. La clau primària té accés complet. Una clau amb nom
pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
limitada a determinats fluxos de treball o a sessions aprovades, a una
llista d'adreces IP i a una data de caducitat. 401 significa que la clau
és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
clau, que la clau no té accés a aquest recurs o acció, o que la
sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
ruta de sessió significa que la sessió està fora dels fluxos de treball
o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
URL d'imatge, vídeo i PDF com a null, i una clau sense permís
d'escriptura de sessions rep els enllaços de sessió i els tokens com a
null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.