Saltar al contingut principal
POST
curl

Autoritzacions

x-api-key
string
header
requerit

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.

Cos

application/json
transaction_id
string
requerit

El teu identificador únic per a aquesta transacció (màxim 128 caràcters).

Exemple:

"your-txn-2026-05-17-001"

transaction_category
enum<string>
requerit

Categoria de la transacció. També s'accepten àlies en CamelCase (travelRule, userPlatformEvent, gamblingBet, …); el valor emmagatzemat/retornat és en camelCase per a les categories de diverses paraules.

Opcions disponibles:
finance,
kyc,
travel_rule,
user_event,
audit_trail_event,
gambling_bet,
gambling_limit_change,
gambling_bonus_change,
travelRule
Exemple:

"finance"

transaction_details
object
requerit

Detalls financers principals de la transacció.

subject
object
requerit

El subjecte (sol·licitant) de la transacció.

transaction_at
string<date-time>

Quan va tenir lloc la transacció. Per defecte pren l'hora actual si s'omet.

time_zone
string

Identificador de zona horària IANA, p. ex. Europe/Madrid.

counterparty
object

La contrapart de la transacció (opcional).

custom_properties
object

Parells clau-valor arbitraris adjunts a la transacció. Cada clau es pot referenciar a les condicions de les regles amb la ruta de camp custom_values.<key>.

Exemple:
travel_rule_details
object

Dades de Travel Rule. Quan Travel Rule està activat i transaction_category és travel_rule, Didit gestiona l'intercanvi directament: ignora status, protocol, required i obligations_count, i utilitza originator_data, beneficiary_data i metadata. En cas contrari, Didit emmagatzema aquests valors com un registre passiu de Travel Rule. Mentre Travel Rule està actiu, una transferència sortint igual o superior al teu llindar ha d'incloure el que requereix el seu règim (TFR de la UE o Recomanació 16 del GAFI), comprovat en les parts que envies: un camp absent respon 400 sota travel_rule_details.originator_data o travel_rule_details.beneficiary_data, per exemple "EU TFR requires the originator name."

network_snapshot
object

Instantània precalculada del graf de xarxa.

include_crypto_screening
boolean | null

Sobreescriptura per transacció per al cribratge d'analítica blockchain de criptomonedes. Quan és true, el cribratge de criptomonedes es realitza independentment del valor per defecte de l'aplicació. Quan és false, el cribratge de criptomonedes s'omet encara que estigui activat a la configuració de l'aplicació. Si s'omet o és null, s'utilitza el valor per defecte a nivell d'aplicació configurat a la consola. El cribratge de criptomonedes requereix transaction_details.direction, currency_kind: "crypto", una cadena/moneda i l'adreça de la cartera seleccionada segons la direcció: el cribratge previ a la transferència entrant utilitza counterparty.payment_method.account_id, el cribratge per hash de transacció entrant utilitza subject.payment_method.account_id, i el cribratge sortint utilitza counterparty.payment_method.account_id. Quan transaction_details.payment_reference_id conté un hash de transacció de blockchain, Didit realitza el cribratge de la transacció i retorna l'enriquiment del resum de la transacció quan estigui disponible.

Resposta

Transacció enviada i monitorada. El cos és el detall complet de la transacció (mateixa estructura que GET /v3/transactions/{transaction_id}/), reflectint els resultats de les regles ja aplicats.

Registre complet de monitoratge per a una transacció, tal com el retornen GET /v3/transactions/{transaction_id}/ i POST /v3/transactions/.

uuid
string<uuid>

Identificador de transacció estable de Didit. Fes-lo servir com a {transaction_id} per a les crides de seguiment.

environment
enum<string>

Entorn de l'aplicació propietària de la transacció. Una transacció sandbox s'emmagatzema però mai s'avalua, se sotmet a cribratge, es notifica ni es factura, de manera que el seu rule_runs buit significa "no avaluada".

Opcions disponibles:
live,
sandbox
transaction_number
integer

Número seqüencial de transacció en l'àmbit de l'aplicació que es mostra a la consola (p. ex. 4123).

txn_id
string

El transaction_id que has proporcionat en el moment de la creació (màx. 128 caràcters). Únic per aplicació.

txn_date
string<date-time>

Quan va tenir lloc la transacció (a partir de transaction_at; per defecte pren l'hora d'enviament).

zone_id
string | null

Identificador de zona horària IANA proporcionat en el moment de la creació.

transaction_type
string

Categoria de primer nivell tal com s'emmagatzema: finance, kyc, travelRule, userPlatformEvent, gamblingBet, gamblingLimitChange, gamblingBonusChange, auditTrailEvent. Tingues en compte que els valors de diverses paraules es retornen en camelCase fins i tot quan s'envien en snake_case.

action_type
string

Subtipus dins de la categoria (p. ex. deposit, withdrawal, transfer). Per defecte pren la categoria quan no s'especifica.

direction
enum<string>

Direcció relativa al subjecte. S'emmagatzema en majúscules independentment de les majúscules o minúscules enviades (s'accepten in/out/inbound/outbound a l'entrada).

Opcions disponibles:
INBOUND,
OUTBOUND
status
enum<string>

Veredicte de monitoratge actual. Les transaccions es creen com a APPROVED; les regles poden canviar-les a IN_REVIEW/DECLINED de manera sincrònica.

Opcions disponibles:
APPROVED,
IN_REVIEW,
DECLINED,
AWAITING_USER
source
enum<string>

Com s'ha originat el registre: LIVE per a transaccions enviades a través de l'API o l'SDK, IMPORTED per a transaccions carregades mitjançant la importació des de la consola.

Opcions disponibles:
LIVE,
IMPORTED
amount
string

Import de la transacció com a cadena decimal sense els zeros finals (p. ex., "1500", "0.5", "0.123456789012345678"). Fins a 18 decimals.

currency
string

Codi de moneda de amount. S'accepta qualsevol codi alfabètic ISO 4217 (p. ex. EUR, USD, NGN), així com un símbol d'actiu cripto (p. ex. BTC). És preferible utilitzar un codi actualment en circulació. No tots els codis acceptats tenen tipus de canvi: quan no n'hi ha cap de disponible per al codi (per exemple, la unitat de compte ISO XSU, o un símbol cripto que Didit no cotitza), la conversió automàtica falla i preferred_currency_amount es retorna null tret que la sol·licitud hagi proporcionat un amount_in_default_currency preconvertit.

currency_type
string | null

fiat o crypto, tal com s'ha indicat a currency_kind.

amount_in_default_currency
string | null

Import preconvertit que has proporcionat, com a cadena decimal sense zeros finals.

default_currency_code
string | null
preferred_currency_amount
string | null

amount convertit a la moneda preferida de l'aplicació, quan estigui disponible.

preferred_currency_code
string | null
payment_details
string | null

Referència de pagament o concepte de text lliure de l'enviament.

payment_txn_id
string | null

Referència del sistema de pagament extern (p. ex. hash de la transacció a la blockchain) de payment_reference_id.

score
integer

Puntuació de risc acumulada per les regles (normalment 0–100). Com més alta, més risc.

severity
enum<string> | null

Gravetat de risc categòrica establerta per regles/proveïdors (UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL). null fins que algun element l'estableixi.

Opcions disponibles:
UNKNOWN,
LOW,
MEDIUM,
HIGH,
CRITICAL
decision_reason_code
string | null

Motiu llegible per màquina per a l'status actual.

decision_reason_label
string | null

Etiqueta fàcil de llegir per a decision_reason_code.

vendor_data
string | null

Còpia de conveniència del vendor_data del sol·licitant.

metadata
object

Instantània dels payloads de subject i counterparty tal com es van enviar en el moment de la creació.

props
object

Les custom_properties que has proporcionat en crear. Cada clau es pot referenciar en les condicions de les regles com a custom_values.<key>.

tags
object[]

Etiquetes adjuntades a la transacció (manualment o per regles).

parties
object[]

Parts de la transacció (sol·licitant, contrapart).

payment_methods
object[]

Mètodes de pagament vinculats a la transacció.

documents
object[]

Fitxers adjunts a la transacció des de la consola. [] quan no n'hi ha cap.

activities
object[]

Entrades del registre d'activitat (creació, notes, revisions manuals, canvis d'estat).

alerts
object[]

Sempre buit actualment. Una alerta oberta és una transacció amb estat IN_REVIEW o AWAITING_USER.

rule_runs
object[]

Resultats d'execució per regla: quina regla s'ha activat, amb quin impacte en la puntuació.

provider_results
object[]

Payloads en brut dels proveïdors (Cribratge AML, anàlisi de blockchain, etc.).

travel_rule
object | null

Transferència o comprovació de Travel Rule. S'emplena quan s'ha enviat travel_rule_details, i també quan Travel Rule està activat i la transacció s'ha creat amb transaction_category: travelRule (Didit inicia l'intercanvi directament, fins i tot sense travel_rule_details). null quan no existeix cap transferència o comprovació. En una transferència entrant, els camps originator_data i beneficiary_data de la contrapart romanen emmascarats (data_masked: true) fins que es confirma la titularitat de la cartera.

network_snapshot
object | null

Instantània del graf de transaccions/parts relacionades utilitzada pel motor de regles. O bé el network_snapshot enviat amb la transacció o bé el graf que Didit construeix a partir d'un cribratge AML de carteres satisfactori (que substitueix el que s'hagi enviat). null quan cap dels dos existeix.

remediation
object | null

Sessió de correcció oferta a l'usuari quan es requereix una reverificació. Substituïda per action_required, que és el bloc canònic; es manté per compatibilitat amb versions anteriors.

action_required
Verification session · object

Acció pendent de l'usuari final necessària per completar aquesta transacció, o null si no n'hi ha cap. Els SDK de Didit inicien automàticament l'acció per defecte i actualitzen la transacció quan finalitza. Dues variants, discriminades per type: verification_session (una sessió de verificació allotjada creada per una acció de regla) i wallet_ownership (una sessió de widget de titularitat de la cartera generada automàticament per a una transferència de Travel Rule que necessita un comprovant de control de la cartera, regulada per la configuració de Travel Rule auto_wallet_verification). Quan totes dues es podrien aplicar, wallet_ownership té prioritat perquè bloqueja l'intercanvi de Travel Rule.

cost_breakdown
object | null

Cost d'aquesta transacció: total_price i items, un per càrrec, cadascun amb usage_type, price, details i created_at. Un nou cribratge de la mateixa transacció és un element nou.

Darrera modificació el 7 de novembre del 2026