CryptoApis::CreateCoinsTransactionRequestFromAddressRI

Properties

Name Type Description Notes
address_tag Integer Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address along with the Source Classic Address. [optional]
callback_secret_key String Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our Documentation. [optional]
callback_url String Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`. [optional]
classic_address String Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the source address is an x-Address. [optional]
fee_priority String Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".
note String Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request. [optional]
recipients Array<CreateCoinsTransactionRequestFromAddressRIRecipients> Defines the destination for the transaction, i.e. the recipient(s).
senders CreateCoinsTransactionRequestFromAddressRISenders
transaction_request_id String Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which `referenceId` concern that specific transaction request.
transaction_request_status String Defines the status of the transaction request, e.g. &quot;created, &quot;await_approval&quot;, &quot;pending&quot;, &quot;prepared&quot;, &quot;signed&quot;, &quot;broadcasted&quot;, &quot;success&quot;, &quot;failed&quot;, &quot;rejected&quot;, mined&quot;.

Example

require 'crypto_apis'

instance = CryptoApis::CreateCoinsTransactionRequestFromAddressRI.new(
  address_tag: 3999472835,
  callback_secret_key: yourSecretString,
  callback_url: https://example.com,
  classic_address: rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z,
  fee_priority: standard,
  note: yourAdditionalInformationhere,
  recipients: null,
  senders: null,
  transaction_request_id: 6017dd02a309213863be9e55,
  transaction_request_status: created
)