Skip to main content

List Strict Receive Payment Paths

GET 
/paths/strict-receive

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.

Request​

Query Parameters

    source_account string

    The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments.

    source_assets string

    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 either source_account or source_assets as an argument is required for strict receive path payments.

    destination_asset_type stringrequired

    Possible values: [native, credit_alphanum4, credit_alphanum12]

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

    destination_asset_issuer string

    The Stellar address of the issuer of the destination asset. Required if the destination_asset_type is not native.

    destination_asset_code string

    The code for the destination asset. Required if the destination_asset_type is not native.

    destination_amount stringrequired

    The amount of the destination asset that should be received.

Responses​

Success

Schema

    _embedded

    object

    records

    object[]

  • Array [

    • source_asset_type string
    source_asset_code string
    source_asset_issuer address (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

    source_amount string
    destination_asset_type string
    destination_asset_code string
    destination_asset_issuer address (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

    destination_amount string

    path

    object[]

  • Array [

    • asset_type stringrequired
    asset_code string
    asset_issuer address (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

  • ]

  • ]

Loading...
Last updated on by Elliot Voris