Payment paths
xrpl_pathsMulti-hop payment paths and their source cost. When to use: Before a cross-currency or multi-hop payment: to see whether a route exists and how much the source would spend to deliver the amount. A call can take up to about 20 seconds and paths may be non-optimal. Prefer another tool: To check whether a direct payment can succeed (use /v1/xrpl/payment-readiness), or for the single-hop cost of a trade on one pair (use /v1/xrpl/slippage, which compares the order book and the AMM). Example: xrpl_paths {"source":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh","destination":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B","asset":"XRP","amount":"1"}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asset | Yes | Asset delivered: XRP or CODE.issuer (3-character or 40-hex code, classic issuer) | |
| amount | Yes | Positive decimal amount of asset the destination receives | |
| source | Yes | Sending account: valid classic XRPL address (r..., checksum verified) | |
| send_max | No | Most the source may spend, in send_max_asset; not with source_assets | |
| destination | Yes | Receiving account: valid classic XRPL address | |
| source_assets | No | Comma-separated assets the source may spend (1 to 4); not with send_max | |
| send_max_asset | No | Asset of send_max: XRP or CODE.issuer; give it with send_max |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | Yes | ||
| warnings | Yes | Non-blocking warnings | |
| alternatives | Yes | Path alternatives; empty when none was found | |
| paths_may_be_non_optimal | Yes | Path finding is best effort: a cheaper path may exist |