Skip to main content

List Strict Send Payment Paths

GET 

/paths/strict-send:source_asset_type:source_amount

The strict send payment path endpoint lists the paths a payment can take based on the amount of an asset you want to send. The source asset amount stays constant, and the type and amount of an asset received varies based on offers in the order books. For this search, Horizon loads a list of assets that the recipient can recieve (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned.

Request

Path Parameters

    source_asset_type stringrequired

    Possible values: [native, credit_alphanum4, credit_alphanum12]

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

    source_amount anyrequired

    The amount of the source asset that should be sent.

Query Parameters

    source_account any

    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.

    source_asset_issuer any

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

    source_asset_code any

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

    destination_account any

    The Stellar address of the reciever. 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.

    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.

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...