Skip to content

TravelRuleValidateFullTransactionRequest.md

Latest commit

 

History

History
48 lines (34 loc) · 5.2 KB

TravelRuleValidateFullTransactionRequest.md

File metadata and controls

48 lines (34 loc) · 5.2 KB

TravelRuleValidateFullTransactionRequest

Properties

Name Type Description Notes
originator TravelRuleValidatePiiIVMS [default to undefined]
beneficiary TravelRuleValidatePiiIVMS [default to undefined]
originatorVASPdid string The Decentralized Identifier (DID) of the exchange (VASP) that is sending the virtual assets. This identifier is unique to the exchange and is generated when the exchange's account is created in the Notabene network. [optional] [default to undefined]
beneficiaryVASPdid string The Decentralized Identifier (DID) of the exchange (VASP) that is receiving the virtual assets. This identifier is unique to the exchange and is generated when the exchange's account is created in the Notabene network. [optional] [default to undefined]
transactionAsset string Transaction asset symbol (e.g., BTC, ETH, USDC). By using the `notation` query string, users can select the type of asset notation: - `fireblocks`: Converts asset symbols to Fireblocks notation. - `notabene`: Retains the original Notabene asset symbol format. [optional] [default to undefined]
transactionAmount string Transaction amount in the transaction asset. For example, if the asset is BTC, the amount is the value in BTC units. By using the `notation` query string, users can select the type of amount notation: - `fireblocks`: Converts the amount to Fireblocks notation (e.g., adjusted for decimals). - `notabene`: Retains the original Notabene amount format. [optional] [default to undefined]
originatorVASPname string The name of the VASP acting as the transaction originator. [optional] [default to undefined]
beneficiaryVASPname string The name of the VASP acting as the transaction beneficiary. [optional] [default to undefined]
transactionBlockchainInfo TravelRuleTransactionBlockchainInfo [optional] [default to undefined]
encrypted string Encrypted data related to the transaction. [optional] [default to undefined]
protocol string The protocol used to perform the travel rule. [optional] [default to undefined]
skipBeneficiaryDataValidation boolean Whether to skip validation of beneficiary data. [optional] [default to undefined]
travelRuleBehavior boolean Whether to check if the transaction complies with the travel rule in the beneficiary VASP's jurisdiction. [optional] [default to undefined]
originatorRef string A reference ID related to the originator of the transaction. [optional] [default to undefined]
beneficiaryRef string A reference ID related to the beneficiary of the transaction. [optional] [default to undefined]
travelRuleBehaviorRef string A reference ID related to the travel rule behavior. [optional] [default to undefined]
originatorProof TravelRuleOwnershipProof [optional] [default to undefined]
beneficiaryProof TravelRuleOwnershipProof [optional] [default to undefined]
beneficiaryDid string The Decentralized Identifier (DID) of the person at the receiving exchange (VASP). This identifier is generated when the customer is registered in the Notabene network, or automatically created based on the `beneficiaryRef`. - If neither `beneficiaryRef` nor `beneficiaryDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. [optional] [default to undefined]
originatorDid string The Decentralized Identifier (DID) of the person at the exchange (VASP) who is requesting the withdrawal. This identifier is generated when the customer is registered in the Notabene network or automatically created based on the `originatorRef`. - If neither `originatorRef` nor `originatorDid` is provided in the `txCreate` payload, a new random DID is generated for every transaction. [optional] [default to undefined]
isNonCustodial boolean Indicates if the transaction involves a non-custodial wallet. [optional] [default to undefined]
notificationEmail string The email address where a notification should be sent upon completion of the travel rule [optional] [default to undefined]
pii TravelRulePiiIVMS [optional] [default to undefined]
pii_url string The URL of the personal identifiable information related to the transaction [optional] [default to undefined]

Enum: TravelRuleValidateFullTransactionRequestProtocolEnum

  • TrLight (value: 'TRLight')

  • Trp (value: 'TRP')

  • OpenVasp (value: 'OpenVASP')

  • Gtr (value: 'GTR')

[Back to top] [Back to API list] [Back to Model list] [Back to README]