Skip to main content

Path Payment Strict Receive Object

Sends a payment from one account to another in a path through the order books, starting as one asset and ending as another. Path payments that are Strict Receive designate the payment amount in the asset received.

See the Path Payment Strict Receive errors.

  • ATTRIBUTEDATA TYPE

    DESCRIPTION

  • asset_typestring

    The type of asset being received. Either native, credit_alphanum4, or credit_alphanum12.

  • asset_codestring

    The code for the asset being received. Appears if the asset_type is not native.

  • asset_issuerstring

    The Stellar address of the issuer of the asset being received. Appears if the asset_type is not native.

  • fromstring

    The payment sender’s public key.

  • tostring

    The payment recipient’s public key.

  • amountstring

    Amount received designated in the destination asset.

  • patharray of objects

    The intermediary assets that this path hops through.

    Show child attributes
    • asset_codestring

      The code for this intermediary asset.

    • asset_issuerstring

      The Stellar address of the intermediary asset’s issuer.

    • asset_typestring

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

  • source_amountstring

    Amount sent designated in the source asset.

  • source_maxstring

    The maximum amount to be sent designated in the source asset.

  • source_asset_typestring

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

  • source_asset_codestring

    The code for the source asset.

  • source_asset_issuerstring

    The Stellar address of the source asset’s issuer.