PATTERN_TYPE_HASH256
PATTERN_TYPE_HASH256
The hex representation of a 256-bit hash
A flattened Payment object used by the ripple-rest API
PATTERN_TYPE_RESOURCEID
A client-supplied unique identifier (ideally a UUID) for this transaction used to prevent duplicate payments and help confirm the transaction's final status. All ASCII printable characters are allowed. Note that 256-bit hex strings are disallowed because of the potential confusion with transaction hashes.
$noDirectRipple : boolean
A boolean that can be set to true if paths are specified and the sender would like the Ripple Network to disregard any direct paths from the source_account to the destination_account. This may be used to take advantage of an arbitrage opportunity or by gateways wishing to issue balances from a hot wallet to a user who has mistakenly set a trustline directly to the hot wallet
$result : string
(/te[cfjlms][A-Za-z_]+/) The rippled code indicating the success or failure type of the payment. The code "tesSUCCESS" indicates that the payment was successfully validated and written into the Ripple Ledger. All other codes will begin with the following prefixes: "tec", "tef", "tel", or "tej"
$sourceBalanceChanges : \Amount[]
Parsed from the validated transaction metadata, this array represents all of the changes to balances held by the source_account. Most often this will have one amount representing the Ripple Network fee and, if the source_amount was not XRP, one amount representing the actual source_amount that was sent
$destinationBalanceChanges : \Amount[]
Parsed from the validated transaction metadata, this array represents the changes to balances held by the destination_account. For those receiving payments this is important to check because if the partial_payment flag is set this value may be less than the destination_amount
__construct(array $data) : \RippleRestPayment
Create a new instance of RippleRestPayment.
| array | $data | (defaults to |
getSourceAmount() : \RippleRestAmount
An optional amount that can be specified to constrain cross-currency payments
setSourceAmount(\RippleRestAmount $value) : null
An optional amount that can be specified to constrain cross-currency payments
| \RippleRestAmount | $value |
setSourceSlippage(string $value) : null
An optional cushion for the source_amount to increase the likelihood that the payment will succeed. The source_account will never be charged more than source_amount.value + source_slippage
| string | $value | (FloatString) |
getDestinationAmount() : \RippleRestAmount
The amount the destination_account will receive
setDestinationAmount(\RippleRestAmount $value) : null
The amount the destination_account will receive
| \RippleRestAmount | $value |
getNoDirectRipple() : boolean
A boolean that can be set to true if paths are specified and the sender would like the Ripple Network to disregard any direct paths from the source_account to the destination_account. This may be used to take advantage of an arbitrage opportunity or by gateways wishing to issue balances from a hot wallet to a user who has mistakenly set a trustline directly to the hot wallet
setNoDirectRipple(boolean $value) : null
A boolean that can be set to true if paths are specified and the sender would like the Ripple Network to disregard any direct paths from the source_account to the destination_account. This may be used to take advantage of an arbitrage opportunity or by gateways wishing to issue balances from a hot wallet to a user who has mistakenly set a trustline directly to the hot wallet
| boolean | $value |
getResult() : string
The rippled code indicating the success or failure type of the payment. The code "tesSUCCESS" indicates that the payment was successfully validated and written into the Ripple Ledger. All other codes will begin with the following prefixes: "tec", "tef", "tel", or "tej"
(/te[cfjlms][A-Za-z_]+/)
setResult(string $value) : null
The rippled code indicating the success or failure type of the payment. The code "tesSUCCESS" indicates that the payment was successfully validated and written into the Ripple Ledger. All other codes will begin with the following prefixes: "tec", "tef", "tel", or "tej"
| string | $value | ( |
getLedger() : string
The string representation of the index number of the ledger containing the validated or failed payment. Failed payments will only be written into the Ripple Ledger if they fail after submission to a rippled and a Ripple Network fee is claimed
(/^[0-9]+$/)
setLedger(string $value) : null
The string representation of the index number of the ledger containing the validated or failed payment. Failed payments will only be written into the Ripple Ledger if they fail after submission to a rippled and a Ripple Network fee is claimed
| string | $value | ( |
getSourceBalanceChanges() : \Amount[]
Parsed from the validated transaction metadata, this array represents all of the changes to balances held by the source_account. Most often this will have one amount representing the Ripple Network fee and, if the source_amount was not XRP, one amount representing the actual source_amount that was sent
setSourceBalanceChanges(\Amount[] $value) : null
Parsed from the validated transaction metadata, this array represents all of the changes to balances held by the source_account. Most often this will have one amount representing the Ripple Network fee and, if the source_amount was not XRP, one amount representing the actual source_amount that was sent
| \Amount[] | $value |
getDestinationBalanceChanges() : \Amount[]
Parsed from the validated transaction metadata, this array represents the changes to balances held by the destination_account. For those receiving payments this is important to check because if the partial_payment flag is set this value may be less than the destination_amount
setDestinationBalanceChanges(\Amount[] $value) : null
Parsed from the validated transaction metadata, this array represents the changes to balances held by the destination_account. For those receiving payments this is important to check because if the partial_payment flag is set this value may be less than the destination_amount
| \Amount[] | $value |