List Strict Receive Payment Paths
The strict receive payment path endpoint lists the paths a payment can take based on the amount of an asset you want the recipient to receive. The destination asset amount stays constant, and the type and amount of an asset sent varies based on offers in the order books.
For this search, Horizon loads a list of assets available to the sender (based on source_account
or source_assets
) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the destination_amount
are returned.
GET | /paths/strict-receive?source_account={:account_id}&source_assets={:asset_list}&destination_asset_type={native,credit_alphanum4,credit_alphanum12}&destination_asset_code={:asset_code}&destination_asset_issuer={:account_id}&destination_amount={:amount} |
ARGUMENTREQUIRED
DESCRIPTION
source_accountoptional
The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either
source_account
orsource_assets
as an argument is required for strict receive path payments.source_assetsoptional
A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as
CODE:ISSUER_ACCOUNT
. For example:USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX
. Using eithersource_account
orsource_assets
as an argument is required for strict receive path payments.destination_asset_typerequired
The type for the destination asset. Either
native
,credit_alphanum4
, orcredit_alphanum12
.destination_asset_issueroptional
The Stellar address of the issuer of the destination asset. Required if the
destination_asset_type
is notnative
.destination_asset_codeoptional
The code for the destination asset. Required if the
destination_asset_type
is notnative
.destination_amountrequired
The amount of the destination asset that should be received.