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.
Path Parameters
- destination_asset_type string required
Possible values: [
native
,credit_alphanum4
,credit_alphanum12
]The type for the destination asset. Either native, credit_alphanum4, or credit_alphanum12.
- destination_amount any required
The amount of the destination asset that should be received.
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.
- destination_asset_issuer any
The Stellar address of the issuer of the destination asset. Required if the destination_asset_type is not native.
- destination_asset_code any
The code for the destination asset. Required if the destination_asset_type is not native.
- 200
Success
- application/json
- Schema
- Example (from schema)
- ListStrictRecievePaymentPaths
Schema
_embedded object
records object[]
Array [source_asset_type stringsource_asset_code stringsource_asset_issuer addressPossible values: Value must match regular expression
G[A-Z0-9]{55}
source_amount stringdestination_asset_type stringdestination_asset_code stringdestination_asset_issuer addressPossible values: Value must match regular expression
G[A-Z0-9]{55}
destination_amount stringpath object[]
Array [asset_type string requiredasset_code stringasset_issuer addressPossible values: Value must match regular expression
G[A-Z0-9]{55}
]]
{
"_embedded": {
"records": [
{
"source_asset_type": "string",
"source_asset_code": "string",
"source_asset_issuer": "string",
"source_amount": "string",
"destination_asset_type": "string",
"destination_asset_code": "string",
"destination_asset_issuer": "string",
"destination_amount": "string",
"path": [
{
"asset_type": "string",
"asset_code": "string",
"asset_issuer": "string"
}
]
}
]
}
}
{
"_embedded": {
"records": [
{
"source_asset_type": "credit_alphanum4",
"source_asset_code": "CNY",
"source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX",
"source_amount": "28.9871131",
"destination_asset_type": "credit_alphanum4",
"destination_asset_code": "BB1",
"destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
"destination_amount": "5.0000000",
"path": [
{
"asset_type": "credit_alphanum4",
"asset_code": "XCN",
"asset_issuer": "GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"
},
{
"asset_type": "native"
}
]
},
{
"source_asset_type": "credit_alphanum4",
"source_asset_code": "CNY",
"source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX",
"source_amount": "29.0722784",
"destination_asset_type": "credit_alphanum4",
"destination_asset_code": "BB1",
"destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
"destination_amount": "5.0000000",
"path": [
{
"asset_type": "credit_alphanum4",
"asset_code": "ULT",
"asset_issuer": "GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"
},
{
"asset_type": "native"
}
]
},
{
"source_asset_type": "credit_alphanum4",
"source_asset_code": "CNY",
"source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX",
"source_amount": "29.4000002",
"destination_asset_type": "credit_alphanum4",
"destination_asset_code": "BB1",
"destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
"destination_amount": "5.0000000",
"path": [
{
"asset_type": "native"
}
]
},
{
"source_asset_type": "credit_alphanum4",
"source_asset_code": "CNY",
"source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX",
"source_amount": "31.8955888",
"destination_asset_type": "credit_alphanum4",
"destination_asset_code": "BB1",
"destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
"destination_amount": "5.0000000",
"path": [
{
"asset_type": "credit_alphanum4",
"asset_code": "USD",
"asset_issuer": "GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"
},
{
"asset_type": "native"
}
]
},
{
"source_asset_type": "credit_alphanum4",
"source_asset_code": "CNY",
"source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX",
"source_amount": "34.7086084",
"destination_asset_type": "credit_alphanum4",
"destination_asset_code": "BB1",
"destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
"destination_amount": "5.0000000",
"path": [
{
"asset_type": "credit_alphanum4",
"asset_code": "USD",
"asset_issuer": "GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"
},
{
"asset_type": "native"
}
]
}
]
}
}