Ana içeriğe geç

Received

Genel Bakış

/v1/notify/received webhook'u, ClearTX platformuna yeni bir işlem aktarıldığında tetiklenir. Webhook hem MAIN hem de BASIC protokollerinde kullanılır:

  • MAIN akışında beneficiary tarafı, yalnızca işlem meta verilerini (varlık, tutar, adresler, protokol) alır.
  • BASIC akışında payload, IVMS.101 uyumlu pii alanını da içerir; beneficiary tarafı kişisel bilgileri ilk bildirimde alır.

Tetiklenme Koşulları

  • Originator KVHS /v1/transactions/initiate çağrısını tamamladı.
  • ClearTX, işlemi beneficiary KVHS'ye iletmeye hazır.
  • (BASIC) PII verisi şifrelenerek bildirime eklendi.

Webhook Endpoint

POST /v1/notify/received

Payload

{
"transactionRef": "6f61b14a-60ec-4569-8ba9-b675dae62159",
"protocol": "MAIN",
"status": "RECEIVER_NOTIFIED",
"originatorVASPdid": "did:web:originator.example",
"beneficiaryVASPdid": "did:web:beneficiary.example",
"transactionAsset": "BTC-BTC",
"transactionAmount": "0.00320000",
"transactionAssetDecimals": 8,
"pii": {
/* PII verisi */
}
}

Alanlar

AlanAçıklama
transactionRefClearTX tarafından üretilen benzersiz işlem referansı.
protocolMAIN veya BASIC.
statusHer zaman RECEIVER_NOTIFIED.
originatorVASPdidOriginator KVHS DID.
beneficiaryVASPdidBeneficiary KVHS DID.
transactionAssetİşlemde kullanılan varlık çifti (ör. BTC-BTC).
transactionAmountString olarak tutar; transactionAssetDecimals ile yorumlanır.
transactionAssetDecimalsVarlığın ondalık basamak sayısı. 0 ise human readable format kullanılır.
piiIVMS.101 uyumlu kişisel verileri içerir.

Bu Webhook Ne Zaman Tetiklenir

Bu webhook başka bir KVHS'ten yeni bir transaction bildirimi alındığında tetiklenir.

Yanıt Gereksinimleri

  • 200 OK: Bildirim işlendi.
  • >=400: ClearTX yeniden deneme stratejisini uygular.