resolve_alias
Resolve a human-readable financial alias (pay: address) to payment endpoints and routing metadata. Call this before initiating any payment to a pay: address. Returns the preferred rail, fallback endpoints, an ISO 20022 hint, and a compliance signal. Anonymous calls return status only; a free API key (no credit card) unlocks the endpoint set — which rails and currencies the alias accepts — via POST /api/v1/access-requests. You do NOT need a key to pay: get_payment_requirements returns a payable address to any caller. Example: resolve_alias('pay:acme.user').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | No | Optional payment amount (decimal string) — refines rail scoring. | |
| currency | No | Optional ISO 4217 currency code. Defaults to USD. | |
| alias_uri | Yes | The pay: address to resolve. E.g. 'pay:acme.user'. | |
| preferred_rail | No | Optional rail hint (e.g. 'xrpl', 'fednow'). Advisory only. |