Skip to main content
GET
cURL
This method will use 10 Compute Units.

Query Parameters

source_asset_type
enum<string>
required

The type for the source asset. Either native, credit_alphanum4, or credit_alphanum12.

Available options:
native,
credit_alphanum4,
credit_alphanum12
source_asset_issuer
string

The Stellar address of the issuer of the source asset. Required if the source_asset_type is not native.

Example:

"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"

source_asset_code
string

The code for the source asset. Required if the source_asset_type is not native.

Example:

"USD"

source_amount
string
required

The amount of the source asset that should be sent.

Example:

"5"

destination_account
string

The Stellar address of the receiver. Any returned path must end with an asset that the recipient can receive. Using either source_account or source_assets as an argument is required for strict send path payments.

Example:

"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"

destination_assets
string

A comma-separated list of assets that the recipient can receive. Any returned path must end with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict send path payments.

Example:

"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"

Response

200 - application/json

Success

_embedded
object