Strict Send Payment Paths  [Go SDK]

The Stellar Network allows payments to be made across assets through path payments. A path payment specifies a series of assets to route a payment through, from source asset (the asset debited from the payer) to destination asset (the asset credited to the payee).

A Path Payment Strict Send allows a user to specify the amount of the asset to send. The amount received will vary based on offers in the order books.

A path payment strict send search is specified using:

• The destination account id or destination assets.
• The source asset.
• The source amount.

As part of the search, horizon will load a list of assets available to the source account id or use the assets passed in the request and will find any payment paths from those source assets to the desired destination asset. The source’s amount parameter will be used to determine if a given path can satisfy a payment of the desired amount.

Request

https://horizon-testnet.stellar.org/paths/strict-send?&source_amount={sa}&source_asset_type={at}&source_asset_code={ac}&source_asset_issuer={ai}&destination_account={da}

Arguments

The endpoint will not allow requests which provide both a destination_account and destination_assets parameter. All requests must provide one or the other. The assets in destination_assets are expected to be encoded using the following format:

XLM should be represented as "native". Issued assets should be represented as "Code:IssuerAccountID". "Code" must consist of alphanumeric ASCII characters.

curl Example Request

curl "https://horizon-testnet.stellar.org/paths/strict-send?&source_amount=10&source_asset_type=native&destination_assets=MXN:GC2GFGZ5CZCFCDJSQF3YYEAYBOS3ZREXJSPU7LUJ7JU3LP3BQNHY7YKS"

JavaScript Example Request

var StellarSdk = require('stellar-sdk');
var server = new StellarSdk.Server('https://horizon-testnet.stellar.org');

var sourceAsset = StellarSdk.Asset.native();
var sourceAmount = "20";
var destinationAsset = new StellarSdk.Asset(
  'USD',
  'GDSBCQO34HWPGUGQSP3QBFEXVTSR2PW46UIGTHVWGWJGQKH3AFNHXHXN'
)


server.strictSendPaths(sourceAsset, sourceAmount, [destinationAsset])
  .call()
  .then(function (pathResult) {
    console.log(pathResult.records);
  })
  .catch(function (err) {
    console.log(err)
  })

Response

This endpoint responds with a page of path resources. See path resource for reference.

Example Response

{
  "_embedded": {
    "records": [
      {
        "source_asset_type": "credit_alphanum4",
        "source_asset_code": "FOO",
        "source_asset_issuer": "GAGLYFZJMN5HEULSTH5CIGPOPAVUYPG5YSWIYDJMAPIECYEBPM2TA3QR",
        "source_amount": "100.0000000",
        "destination_asset_type": "credit_alphanum4",
        "destination_asset_code": "FOO",
        "destination_asset_issuer": "GAGLYFZJMN5HEULSTH5CIGPOPAVUYPG5YSWIYDJMAPIECYEBPM2TA3QR",
        "destination_amount": "100.0000000",
        "path": []
      }
    ]
  }
}

Possible Errors

• The standard errors.
• not_found: A not_found error will be returned if no paths could be found to fulfill this payment request