post https://api.notabene.id/tx/create
Creates a new transaction. The fields required in a transaction differ depending on the jurisdiction of the originating VASP.
Additional data may be provided to the beneficiary VASP depending on their jurisdiction.
Related guide: Sending a transaction
Payload - txCreate
| Attribute | Required | Type | Description |
|---|---|---|---|
| transactionAsset | Yes | string | Asset symbol (BTC,ETH) |
| transactionAmount | Yes | string | Amount in base unit of the asset (satoshi, wei, etc) |
| originatorDid | string (common_DID) | ||
| beneficiaryDid | string (common_DID) | ||
| originatorVASPdid | Yes | string (common_DID) | |
| beneficiaryVASPdid | string (common_DID) | ||
| beneficiaryVASPname | string | Beneficiary VASP Name | |
| transactionBlockchainInfo | object (TransactionBlockchainInfo) | Information about the transaction on the blockchain | |
| originator | object (ivms101_Originator) | The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer. | |
| beneficiary | object (ivms101_Beneficiary) | The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer. | |
| encrypted | string | Encrypted Personal Identificable Information (obscure schema-less value) | |
| protocol | string (tr_TravelRuleProtocol) | Enum: "TRLight" "TRP" "OpenVASP" | |
| notificationEmail | string | Beneficiary VASP Notification Email | |
| skipBeneficiaryDataValidation | boolean | Disable beneficiary data validation (opportunistic compliance) | |
| travelRuleBehavior | boolean | If you want check if a transaction requires travel rule information according to the beneficiary VASP's jurisdiction, you can enable it by adding ["travelRuleBehavior":true]. | |
| originatorProof | object (OwnershipProof) | Ownership Proof data | |
| beneficiaryProof | object (OwnershipProof) | Ownership Proof data | |
| pii | object (PII_IVMS) |