Map the options for an intent
map_optionsThe signed Options Map for a PaymentIntent: every rail and provider the graph holds for the pair and size, each with its access facts, documented capacity, settlement window, economics basis (observed, band or unpublished) and evidence class, and whether it sits inside, outside or unknown against the principal's constraints. Each candidate also carries route_family (bank_correspondent or stablecoin_casp), regulatory_risk (stable, watch, restricted or blocked, tied to a tracked rule) and onboarding_status (ready, onboardable, ineligible or unknown, with onboarding_gap naming what's missing) so an agent can filter out ineligible or blocked routes before quoting. route_families lists every family even one with zero candidates, reason no_eligible_provider, rather than hiding it. Sorted by coverage tier, rail class and name, never by a rank. payout_rules lists the rules that reach the payout per route (applies or depends, each with its document; document_not_read when found by search). A guide, not advice. Pass an intent (any form compile_intent takes, including payer) or an intent_id. Free within the daily allowance; a key lifts it. Returns a compact view by default (one short object per candidate, every unknown in full) that points at the signed full map; pass detail: "full" for the whole signed document, or map_id to read back a map made earlier.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| detail | No | compact (default): a short summary that points at the signed full document, sized for a tool result. full: the whole document, which can exceed 100 KB. | |
| intent | No | A PaymentIntent, a flat form or { text, from }. | |
| map_id | No | A map_id from an earlier map_options call: returns that stored, signed map (with expired) instead of making a new one. | |
| country | No | Optional ISO 3166-1 alpha-2 country of the payer (or payee) for a multi-country currency, e.g. CI for XOF: attaches that country's profile (banks, fees, payment-side rules, each with source and confidence) and the receipts measured there. | |
| intent_id | No | An intent compiled earlier. | |
| release_at | No | Optional ISO date-time the payment will be released; default now. Sets each candidate's settlement.release_window. |