Ana içeriğe geç

ClearTX Transaction Initiate Endpoint Kullanımı

Bu belge, ClearTX sistemindeki /v1/transactions/initiate endpoint'ine gönderilecek gövde yapısını protokollere göre örneklerle açıklar.

MAIN protokolü – yalnızca işlem metası gönderilir​

{
  "transactionAsset": "BTC-BTC",
  "transactionAssetDecimals": 8,
  "transactionAmount": "0.00320000",
  "beneficiaryVASPid": "ce422f07-d7ac-4da1-b808-03918d4603c8",
  "beneficiaryVASPdid": "did:web:beneficiary.example",
  "transactionBlockchainInfo": {
    "origin": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "destination": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2"
  },
  "protocol": "MAIN"
}
  • Başlangıçta IVMS/PII paylaşılmaz; CONFIRM sonrası confirmed-data webhook'u ile teslim edilir.
  • transactionAssetDecimals her zaman ilgili varlığın ondalık sayısını göstermelidir (BTC için 8).

BASIC protokolü – IVMS.101/PII başlatmada iletilir​

{
  "transactionAsset": "ETH-USDT",
  "transactionAssetDecimals": 6,
  "transactionAmount": "250.000000",
  "beneficiaryVASPid": "ce422f07-d7ac-4da1-b808-03918d4603c8",
  "beneficiaryVASPdid": "did:web:beneficiary.example",
  "transactionBlockchainInfo": {
    "origin": "0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6",
    "destination": "0x8ba1f109551bD432803012645546eaCe3bDd2fF3"
  },
  "protocol": "BASIC",
  "pii": {
    "originator": {
      "accountNumber": ["ACC-ORIG-001"],
      "originatorPersons": [
        {
          "naturalPerson": {
            "name": [
              {
                "nameIdentifier": [
                  {
                    "primaryIdentifier": "Alice",
                    "secondaryIdentifier": "Johnson"
                  }
                ]
              }
            ],
            "geographicAddress": [
              {
                "addressType": "HOME",
                "streetName": "Oak Avenue",
                "townName": "Los Angeles",
                "country": "US",
                "buildingNumber": "456",
                "postCode": "90210"
              }
            ],
            "nationalIdentification": {
              "countryOfIssue": "US",
              "nationalIdentifier": "987-65-4321",
              "nationalIdentifierType": "SSN"
            }
          }
        }
      ]
    },
    "beneficiary": {
      "accountNumber": ["ACC-BEN-001"],
      "beneficiaryPersons": [
        {
          "naturalPerson": {
            "name": [
              {
                "nameIdentifier": [
                  {
                    "primaryIdentifier": "Bob",
                    "secondaryIdentifier": "Wilson"
                  }
                ]
              }
            ],
            "geographicAddress": [
              {
                "addressType": "HOME",
                "streetName": "King Street",
                "townName": "London",
                "country": "GB",
                "buildingNumber": "12",
                "postCode": "SW1A 1AA"
              }
            ],
            "nationalIdentification": {
              "countryOfIssue": "GB",
              "nationalIdentifier": "AB123456C",
              "nationalIdentifierType": "NINO"
            }
          }
        }
      ]
    }
  }
}
  • accountNumber alanları dizi olarak gönderilir; null kullanılmaz.
  • Tüm IVMS/PII alanları travel rule uyumluluğu için doldurulmalıdır.

NOTIFY protokolü – ClearTX ağı dışında e-posta bildirimi​

{
  "transactionAsset": "BTC-BTC",
  "transactionAssetDecimals": 8,
  "transactionAmount": "0.10000000",
  "beneficiaryVASPdid": "",
  "transactionBlockchainInfo": {
    "origin": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "destination": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2"
  },
  "protocol": "NOTIFY",
  "notificationEmail": "[email protected]",
  "pii": {
    "originator": {
      "originatorPersons": [
        {
          "naturalPerson": {
            "name": [
              {
                "nameIdentifier": [
                  {
                    "primaryIdentifier": "Charlie",
                    "secondaryIdentifier": "Brown"
                  }
                ]
              }
            ],
            "geographicAddress": [
              {
                "addressType": "HOME",
                "streetName": "Pine Street",
                "townName": "Chicago",
                "country": "US",
                "buildingNumber": "789",
                "postCode": "60601"
              }
            ],
            "nationalIdentification": {
              "countryOfIssue": "US",
              "nationalIdentifier": "111-22-3333",
              "nationalIdentifierType": "SSN"
            }
          }
        }
      ]
    },
    "beneficiary": {
      "beneficiaryPersons": [
        {
          "naturalPerson": {
            "name": [
              {
                "nameIdentifier": [
                  {
                    "primaryIdentifier": "Diana",
                    "secondaryIdentifier": "Prince"
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  }
}
  • notificationEmail zorunludur; beneficiary'nin ClearTX kimliği yoksa beneficiaryVASPid/beneficiaryVASPdid boş bırakılabilir.
  • txHash talep edilmez; mevcutsa webhook aşamasında paylaşılabilir.
  • PII verisi e-posta bildirimine kaynak oluşturur; aktarım sırasında şifrelenmelidir.

Dikkat edilmesi gerekenler​

  • Tüm tutarlar string olarak gönderilmelidir.
  • transactionAssetDecimals ilgili varlığın ondalık sayısını göstermelidir; 0 özel bir değer değildir.
  • Protokol tipini doğru seçin ve zorunlu alanları protokole göre doldurun.
  • Daha fazla detay için Initiate endpoint referansı ve PII dokümanı incelenebilir.