get_payment_paths: Prepare Payment

Description Usage Arguments Value

View source: R/get_payment_paths.R

Description

Before you make a payment, it is necessary to figure out the possible ways in which that payment can be made. This method gets a list of possible ways to make a payment, but it does not affect the network: consider it like getting quotes before actually making the payment. You can then choose one of the returned payment objects, modify it as desired (for example, to set slippage values or tags), and then submit the payment for processing.

Usage

1
2
get_payment_paths(address, destination_account, destination_amount, value,
  currency, issuer = "", source_currencies)

Arguments

address

The Ripple address for the source account.

destination_account

The Ripple address for the destination account.

destination_amount

An object of class "Amount". The amount to be sent to the destination account.

value

The quantity of the currency. Ignored if destination_amount is provided.

currency

The currency expressed as a three-character code. Ignored if destination_amount is provided.

issuer

The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP. Ignored if destination_amount is provided.

source_currencies

A string or an object of class "Amount". This is used to filter the returned list of possible payments. Each source currency can be specified either as a currency code, or as a currency code and issuer. If the issuer is not specified for a currency other than XRP, then the results will be limited to the specified currency, but any issuer for that currency will be included in the results. The string should be a comma-separated list of source currencies. Each source currency can be specified either as a currency code (eg, USD), or as a currency code and issuer (eg, USD+r...).

Value

An object of class "Payment"


hmalmedal/ripplerestr documentation built on May 17, 2019, 4:34 p.m.