Skip to main content Link Menu Expand (external link) Document Search Copy Copied

TransferXrp

Model getters

Method name Return type Description Notes
getSenderAccountId() string Sender account ID
Example: 61b3bffddfb389cde19c73be
 
getAccount() string XRP account address. Must be the one used for generating deposit tags.
Example: rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV
 
getAddress() string Blockchain address to send assets
Example: rPRxSZzTFd6Yez3UMxFUPJvnhUhjewpjfV
 
getAmount() string Amount to be sent, in XRP.
Example: 10000
 
getCompliant() bool Compliance check, if withdrawal is not compliant, it will not be processed.
Example: false
[optional]
getAttr() string Destination tag of the recipient account, if any. Must be stringified uint32.
Example: 12355
[optional]
getSourceTag() int Source tag of sender account, if any.
Example: 12355
[optional]
getPaymentId() string Identifier of the payment, shown for created Transaction within Tatum sender account.
Example: 1234
[optional]
getSecret() string Secret for account. Secret, or signature Id must be present.
Example: snSFTHdvSYQKKkYntvEt8cnmZuPJB
 
getSenderNote() string Note visible to owner of withdrawing account.
Example: Sender note
[optional]