SwapEazi MCP

{
  "type": "object",
  "required": [
    "amount",
    "source_currency",
    "target_currency"
  ],
  "properties": {
    "payer": {
      "type": "object",
      "properties": {
        "entity_type": {
          "enum": [
            "corporate",
            "sme",
            "fintech",
            "crypto_native",
            "individual"
          ],
          "type": "string",
          "description": "corporate, sme, fintech, crypto_native or individual."
        },
        "jurisdiction": {
          "type": "string",
          "description": "Optional ISO 3166-1 alpha-2 country of the payer."
        }
      },
      "description": "Optional. Who is paying: { entity_type, jurisdiction }."
    },
    "amount": {
      "type": "number",
      "description": "The amount, greater than zero.",
      "exclusiveMinimum": 0
    },
    "client": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "agent",
            "human"
          ],
          "type": "string",
          "description": "agent or human."
        },
        "agent_id": {
          "type": "string",
          "description": "Optional, self-declared; logged."
        }
      },
      "description": "Optional. Who is asking: { type: agent | human, agent_id }."
    },
    "detail": {
      "enum": [
        "compact",
        "full"
      ],
      "type": "string",
      "description": "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."
    },
    "amount_in": {
      "enum": [
        "source",
        "destination"
      ],
      "type": "string",
      "description": "Which currency amount is stated in. Overrides direction's default, e.g. paying a fixed destination amount while funding from the source currency."
    },
    "direction": {
      "enum": [
        "pay",
        "receive"
      ],
      "type": "string",
      "description": "pay (default): amount is what leaves. receive: amount is what must land."
    },
    "needed_by": {
      "type": "string",
      "description": "Optional ISO date the money must land by. Adds timing_scenarios, fx_exposure and hedge_scenarios to the report, and each option's settlement.release_by: the latest release that lands by this date at the rail's later and earlier typical settle_days (on bank rails, the provider's cut-off on a banking day; the cut-off is not on record)."
    },
    "release_at": {
      "type": "string",
      "description": "Optional ISO date-time the payment will be released; default now. Each option's settlement.release_window states whether its rail moves at that moment (bank rails on banking days only, stablecoin rails around the clock), when it starts moving, the landing dates that follow, any sourced time-based markup, and what is not on record (cut-offs, bank holidays)."
    },
    "beneficiary": {
      "type": "object",
      "properties": {
        "country": {
          "type": "string",
          "description": "ISO 3166-1 alpha-2 country where the supplier is paid, e.g. 'CN'."
        }
      },
      "description": "Optional. Where the supplier is paid: { country }. Its country rules on record (and the payer's, from payer.jurisdiction) are returned as country_rules."
    },
    "constraints": {
      "type": "object",
      "properties": {
        "exclude_providers": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Provider ids or names to leave out."
        },
        "require_licensed_in": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Not yet filterable; listed in what_we_dont_know when given."
        },
        "max_settlement_hours": {
          "type": "number",
          "description": "Maximum hours from release to landing; slower options are marked outside."
        }
      },
      "description": "Optional. The payer's own limits: { max_settlement_hours, exclude_providers, require_licensed_in }."
    },
    "current_quote": {
      "type": "object",
      "required": [
        "rate"
      ],
      "properties": {
        "fees": {
          "type": "number",
          "description": "Optional, in the source currency."
        },
        "rate": {
          "type": "number",
          "description": "Destination units per source unit.",
          "exclusiveMinimum": 0
        },
        "provider": {
          "type": "string",
          "description": "Who gave the quote, e.g. a bank or provider name."
        },
        "quoted_at": {
          "type": "string",
          "description": "ISO 8601 timestamp the quote was given, e.g. '2026-11-04T09:30:00Z'."
        }
      },
      "description": "Optional: a quote already held, measured as given against the reference."
    },
    "rails_allowed": {
      "type": "array",
      "items": {
        "enum": [
          "bank",
          "psp",
          "stablecoin",
          "dex"
        ],
        "type": "string"
      },
      "description": "Default: all. Only bank and stablecoin filter directly today; psp/dex leave every non-excluded rail in."
    },
    "source_currency": {
      "type": "string",
      "description": "ISO 4217 code the payment leaves in, e.g. 'EUR'."
    },
    "target_currency": {
      "type": "string",
      "description": "ISO 4217 code the payment must land in, e.g. 'ZAR'."
    }
  }
}

{
  "title": "Payment Discovery",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "Instead of payables: a payout CSV or pain.001 text."
    },
    "sort": {
      "enum": [
        "landed_cost",
        "arrival_time",
        "answer_rate"
      ],
      "type": "string",
      "description": "Your chosen order for the routes: landed cost against the official rate, stated days to land, or the measured 7-day answer rate. It is your order, stated as yours; SwapEazi does not rank routes."
    },
    "policy": {
      "type": "object",
      "description": "{ approver_role, material_threshold: { amount, currency }, agent_may_record_approval }"
    },
    "sample": {
      "type": "boolean",
      "description": "true: the built-in sample run (synthetic, labelled), no key needed."
    },
    "payables": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "[{ reference, payee: { name, iban?, bic?, account_number?, routing_number?, branch_code?, country? }, amount, currency, due_date?, rail?: bank | provider | stablecoin, via?, wallet? }]"
    },
    "previous": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "The previous run's payables, for changed bank details and amount jumps. Not kept."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "exclude_types": {
      "type": "array",
      "items": {
        "enum": [
          "banks",
          "otc_desks",
          "exchange_books",
          "stablecoin_pools",
          "p2p",
          "ramps",
          "payment_providers"
        ],
        "type": "string"
      },
      "description": "Leave out routes of these rail types. Each route left out is listed with the reason."
    },
    "include_types": {
      "type": "array",
      "items": {
        "enum": [
          "banks",
          "otc_desks",
          "exchange_books",
          "stablecoin_pools",
          "p2p",
          "ramps",
          "payment_providers"
        ],
        "type": "string"
      },
      "description": "Keep only routes of these rail types. Each route left out is listed with the reason."
    },
    "min_answer_rate": {
      "type": "number",
      "description": "Percent, 0 to 100: leave out routes whose measured 7-day answer rate is lower, or not measured (not enough reads). Each is listed with the reason."
    },
    "source_currency": {
      "type": "string",
      "description": "The currency the business pays from, e.g. ZAR."
    }
  }
}

{
  "title": "Run a batch of cross-border payments: assess, assess, prepare",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "run_id",
    "approver"
  ],
  "properties": {
    "run_id": {
      "type": "string",
      "description": "pr_... or pr_sample."
    },
    "approver": {
      "type": "object",
      "description": "{ name, role, id? }: the person who approved. Required."
    },
    "payments": {
      "description": "\"all_prepared\" or a list of payment_ids."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "acknowledge": {
      "type": "boolean",
      "description": "true to approve listed payments that need attention or have no evidence, once the person has assessed them."
    }
  }
}

{
  "title": "Record a named person's approval of a payment run",
  "readOnlyHint": false,
  "openWorldHint": false,
  "idempotentHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "run_id"
  ],
  "properties": {
    "export": {
      "type": "boolean",
      "description": "true: the audit export (JSON) instead of the run."
    },
    "run_id": {
      "type": "string",
      "description": "pr_... from run_payments, or pr_sample."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    }
  }
}

{
  "title": "A payment run's status, per payment, or its audit export",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "description": "Amount, in currency (default the source currency)."
    },
    "weights": {
      "type": "object",
      "description": "Your own scoring weights: { total_cost, speed, reliability, liquidity, compliance }, non-negative, normalised to 1."
    },
    "currency": {
      "type": "string",
      "description": "The currency of amount: the source currency, or the destination one (then it is what the supplier receives)."
    },
    "due_date": {
      "type": "string",
      "description": "YYYY-MM-DD: a route that cannot settle by then is not eligible."
    },
    "priority": {
      "enum": [
        "cost",
        "speed",
        "balanced"
      ],
      "type": "string",
      "description": "Sets the default scoring weights. Default balanced."
    },
    "supplier": {
      "type": "string",
      "description": "Optional. The supplier's name as on the invoice, e.g. 'Lusaka Copper Supplies Ltd'; echoed in the analysis."
    },
    "reference": {
      "type": "string",
      "description": "Optional. Your invoice or payment reference, e.g. 'INV-2207'; echoed in the analysis."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header: names the routes and is not counted."
    },
    "analysis_id": {
      "type": "string",
      "description": "Read a kept analysis (pa_...) instead of making a new one."
    },
    "invoice_text": {
      "type": "string",
      "description": "Paste the invoice or a sentence (e.g. 'Invoice INV-2207, Lusaka Copper Supplies Ltd, Zambia. Amount due: EUR 80,000. Due 2026-11-20'). Or the fields below."
    },
    "source_currency": {
      "type": "string",
      "description": "ISO code you pay from, e.g. EUR or ZAR."
    },
    "existing_provider": {
      "type": "object",
      "description": "Your current provider: { provider, kind: quote | entered_rate | past_payment, rate (destination per source unit) or landed_amount, fees: { transaction, intermediary, payout } in the source currency, fees_deducted_destination, quoted_at, valid_until }."
    },
    "beneficiary_amount": {
      "type": "number",
      "description": "What the supplier must receive, in the destination currency (instead of amount)."
    },
    "destination_country": {
      "type": "string",
      "description": "ISO 3166 alpha-2 or name, e.g. ZM or Mozambique."
    },
    "destination_currency": {
      "type": "string",
      "description": "ISO code the supplier is paid in, e.g. ZMW. Or destination_country."
    }
  }
}

{
  "title": "Recommend a route for one payment",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "Destination currency, ISO code, e.g. ZMW."
    },
    "from": {
      "type": "string",
      "description": "Source currency, ISO code, e.g. EUR."
    },
    "sort": {
      "enum": [
        "landed_cost",
        "arrival_time",
        "answer_rate"
      ],
      "type": "string",
      "description": "Your chosen order for the routes: landed cost against the official rate, stated days to land, or the measured 7-day answer rate. It is your order, stated as yours; SwapEazi does not rank routes."
    },
    "as_of": {
      "type": "string",
      "description": "Assessment time, ISO 8601, within 15 minutes of now (default now). A past assessment is retrieved by assessment_id, never recomputed."
    },
    "amount": {
      "type": "number",
      "description": "Amount leaving, in the source currency. Optional: without it the corridor is assessed at about USD 10,000, labelled."
    },
    "corridor": {
      "type": "string",
      "description": "Instead of from and to: e.g. EUR-ZMW."
    },
    "assessment_id": {
      "type": "string",
      "description": "Retrieve a kept assessment record instead of making a new one."
    },
    "charge_option": {
      "enum": [
        "OUR",
        "SHA",
        "BEN"
      ],
      "type": "string",
      "description": "Who pays the banks' charges on a wire: OUR (payer pays all), SHA (shared), BEN (beneficiary)."
    },
    "exclude_types": {
      "type": "array",
      "items": {
        "enum": [
          "banks",
          "otc_desks",
          "exchange_books",
          "stablecoin_pools",
          "p2p",
          "ramps",
          "payment_providers"
        ],
        "type": "string"
      },
      "description": "Leave out routes of these rail types. Each route left out is listed with the reason."
    },
    "include_types": {
      "type": "array",
      "items": {
        "enum": [
          "banks",
          "otc_desks",
          "exchange_books",
          "stablecoin_pools",
          "p2p",
          "ramps",
          "payment_providers"
        ],
        "type": "string"
      },
      "description": "Keep only routes of these rail types. Each route left out is listed with the reason."
    },
    "payer_country": {
      "type": "string",
      "description": "Two-letter country the money leaves from. Needed when from and to are the same currency (e.g. USD from LR to a USD account in CN): the payment is then assessed as a cross-border transfer, banks' charges and rules, no conversion."
    },
    "min_answer_rate": {
      "type": "number",
      "description": "Percent, 0 to 100: leave out routes whose measured 7-day answer rate is lower, or not measured (not enough reads). Each is listed with the reason."
    },
    "beneficiary_country": {
      "type": "string",
      "description": "Two-letter country of the beneficiary's account; with payer_country for a same-currency payment."
    }
  }
}

{
  "title": "Assess a cross-border payment route before paying",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "amount"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the destination currency (what lands), e.g. 'USD'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the source currency (what leaves), e.g. 'ZAR'."
    },
    "pair": {
      "type": "string",
      "description": "e.g. ZAR-USD or USD-MWK. Or from and to."
    },
    "amount": {
      "type": "number",
      "description": "Ticket size, in the from currency unless amount_currency says otherwise."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "prefunding": {
      "type": "object",
      "description": "{ amount, currency?, corridor?, days_held }: an amount held to prefund the corridor, and for how many days (1 to 365)."
    },
    "amount_currency": {
      "type": "string",
      "description": "The from or the to currency. Default from."
    }
  }
}

{
  "title": "Map liquidity for a currency pair at a ticket size",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "amount"
  ],
  "properties": {
    "amount": {
      "type": "number",
      "description": "The ticket in US dollars (dollar stablecoins at par)."
    },
    "chains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Any of ethereum, tron, solana, base, bsc, arbitrum, polygon. Default all."
    },
    "to_asset": {
      "type": "string",
      "description": "USDC, USDT, ZARP or cNGN (ZAR and NGN map to ZARP and cNGN). Default: the other dollar coin."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header: shows exchange and P2P venue names in the destination block."
    },
    "from_asset": {
      "type": "string",
      "description": "USDC or USDT. Default USDC."
    },
    "destination": {
      "type": "string",
      "description": "Optional supplier country, two letters (e.g. HK, CN, AE, NG, ZA, KE)."
    }
  }
}

{
  "title": "On-chain dollar liquidity at a ticket size",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "intent_id"
  ],
  "properties": {
    "tx": {
      "type": "string",
      "description": "For a stablecoin leg: the transaction hash; read and priced from the chain and added to the payment record."
    },
    "sent": {
      "type": "number",
      "description": "Amount that left, in the source currency."
    },
    "chain": {
      "type": "string",
      "description": "For a stablecoin leg: base, ethereum, arbitrum, optimism, polygon or celo."
    },
    "landed": {
      "type": "number",
      "description": "Amount that arrived, in the destination currency, after every deduction."
    },
    "provider": {
      "type": "string",
      "description": "Defaults to the route selected on the last day."
    },
    "intent_id": {
      "type": "string",
      "description": "The remembered intent to close (remembered.intent_id from route_intent)."
    },
    "settled_at": {
      "type": "string",
      "description": "YYYY-MM-DD"
    }
  }
}

{
  "title": "Record a landed intent",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "run_id",
    "payments"
  ],
  "properties": {
    "run_id": {
      "type": "string",
      "description": "pr_... or pr_sample."
    },
    "dry_run": {
      "type": "boolean",
      "description": "true: validate only, write nothing."
    },
    "payments": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "[{ payment_id, sent_amount, landed_amount, settled_at?, proof_ref, source? }]. proof_ref is an MT103 reference, a transaction hash or a provider reference."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    }
  }
}

{
  "title": "Reconcile what landed on a payment run",
  "readOnlyHint": false,
  "openWorldHint": false,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "policy_id",
    "payment_ref",
    "released_by"
  ],
  "properties": {
    "uetr": {
      "type": "string",
      "description": "The payment's SWIFT UETR (UUID v4), optional: ties the record to the payment itself."
    },
    "amount": {
      "type": "object",
      "properties": {
        "value": {
          "type": "number",
          "description": "Amount released, in amount.currency, greater than zero."
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 code of the released amount, e.g. 'EUR'."
        }
      },
      "description": "The released amount: { value, currency }."
    },
    "map_id": {
      "type": "string",
      "description": "The Options Map (map_id) on file for this payment, if one was made."
    },
    "exception": {
      "type": "object",
      "properties": {
        "reason": {
          "type": "string",
          "description": "Why the payment was released outside the policy, in plain words."
        },
        "approved_by": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Your own id for the approver."
            },
            "role": {
              "type": "string",
              "description": "The approver's role, e.g. 'CFO'."
            }
          },
          "description": "The person who approved the exception: { id, role }."
        }
      },
      "description": "Only when the release falls outside the policy: { reason, approved_by: { id, role } }."
    },
    "policy_id": {
      "type": "string",
      "description": "The organisation's release policy the payment is released under, e.g. 'pol_...'."
    },
    "measure_id": {
      "type": "string",
      "description": "The Measure (msr_...) on file for this payment, if one was made."
    },
    "intent_hash": {
      "type": "string",
      "description": "The intent_hash from compile_intent, so the record proves the map matches this payment."
    },
    "payment_ref": {
      "type": "string",
      "description": "Your internal payment reference, never an account number."
    },
    "released_at": {
      "type": "string",
      "description": "ISO timestamp; defaults to now."
    },
    "released_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Your own id for the releaser, e.g. an employee id or agent id; never a password or key."
        },
        "type": {
          "enum": [
            "human",
            "system",
            "agent"
          ],
          "type": "string",
          "description": "human, system or agent."
        }
      },
      "description": "Who released the payment: { type: human | system | agent, id }."
    },
    "agent_approval": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Your own id for the person who signed off."
        },
        "role": {
          "type": "string",
          "description": "That person's role, e.g. 'Treasurer'."
        }
      },
      "description": "Agent releases only: { id, role } of the person who signed off a release above the policy's agent_autonomy.release_up_to. The role is the policy's agent_autonomy.approver_role."
    }
  }
}

{
  "title": "Record a release",
  "readOnlyHint": false,
  "openWorldHint": false,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "rer_id": {
      "type": "string",
      "description": "Optional. The Release Evidence Record (rer_...) to read. Omit to verify the organisation's whole chain."
    }
  }
}

{
  "title": "Release record status",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {}
}

{
  "title": "Currencies SwapEazi can measure",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "Optional ISO 4217 destination currency, e.g. 'ZMW'."
    },
    "from": {
      "type": "string",
      "description": "Optional ISO 4217 source currency, e.g. 'ZAR'."
    },
    "provider": {
      "type": "string",
      "description": "Optional provider id."
    }
  }
}

{
  "title": "Corridor registry, public tier",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "origin_currency",
    "destination_currency",
    "source_amount"
  ],
  "properties": {
    "quote": {
      "type": "object",
      "required": [
        "landed_amount"
      ],
      "properties": {
        "provider": {
          "type": "string",
          "description": "Who gave the quote, e.g. a bank or provider name; for the record, not used to price."
        },
        "landed_amount": {
          "type": "number",
          "description": "Amount the quote says will land, in the destination currency.",
          "exclusiveMinimum": 0
        }
      },
      "description": "Optional. A quote you already hold, to be measured as given."
    },
    "client_id": {
      "type": "string",
      "description": "Optional. Your own reference, echoed back."
    },
    "source_amount": {
      "type": "number",
      "description": "Amount to send, in the origin currency.",
      "exclusiveMinimum": 0
    },
    "origin_currency": {
      "type": "string",
      "description": "ISO 4217 code, e.g. 'GBP'."
    },
    "allowed_providers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional. Restrict routes to your own already-connected panel, by provider label or id. For embedding this assessment as a mandatory step inside your own already-licensed release pipeline — asking which of YOUR connected providers should carry this, not who exists in the market, the way an execution-management system asks which of its own connected brokers should fill an order. A provider outside the panel is ruled out before scoring, never silently dropped: it appears in ruled_out with reason not_in_callers_connected_panel. Omit for no restriction."
    },
    "origin_jurisdiction": {
      "type": "string",
      "description": "Optional ISO 3166-1 alpha-2 country of the sender."
    },
    "destination_currency": {
      "type": "string",
      "description": "ISO 4217 code, e.g. 'MZN'."
    },
    "max_settlement_hours": {
      "type": "number",
      "description": "Optional. Your delivery-time cap.",
      "exclusiveMinimum": 0
    },
    "require_regulated_lp": {
      "type": "boolean",
      "description": "Default true."
    },
    "max_acceptable_ldi_bps": {
      "type": "number",
      "minimum": 0,
      "description": "Optional. Your cost cap in basis points."
    },
    "destination_jurisdiction": {
      "type": "string",
      "description": "Optional ISO 3166-1 alpha-2 country of the beneficiary."
    }
  }
}

{
  "title": "Pre-trade guardrail assess",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "attestation"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "Optional. The bank's MT103 text or pacs.008 XML for this payment."
    },
    "settlement": {
      "type": "object",
      "required": [
        "landed_amount"
      ],
      "properties": {
        "settled_on": {
          "type": "string",
          "description": "Optional. Value date, YYYY-MM-DD."
        },
        "landed_amount": {
          "type": "number",
          "description": "Amount that arrived, in the destination currency.",
          "exclusiveMinimum": 0
        },
        "source_amount": {
          "type": "number",
          "description": "Optional. Amount that left, including any fee billed on top.",
          "exclusiveMinimum": 0
        }
      },
      "description": "What landed, when no bank message is supplied."
    },
    "attestation": {
      "type": "string",
      "description": "decision.attestation from swapeazi_guardrail_check."
    }
  }
}

{
  "title": "Reconcile a settled payment",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "attestation"
  ],
  "properties": {
    "attestation": {
      "type": "string",
      "description": "The attestation string from a decision or reconciliation."
    }
  }
}

{
  "title": "Verify a SwapEazi record",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {
    "chain": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Optional. The records around it, in any order; links are verified in seq order."
    },
    "record": {
      "type": "object",
      "description": "One release record, as returned by record_release, release_status or GET /api/v1/releases/{id}."
    }
  }
}

{
  "title": "Verify a release record",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {
    "bic": {
      "type": "string",
      "description": "A BIC/SWIFT code, 8 or 11 characters."
    },
    "iban": {
      "type": "string",
      "description": "An IBAN, spaces allowed."
    },
    "address": {
      "type": "string",
      "description": "An EVM address, '0x' followed by 40 hex characters."
    },
    "mxClabe": {
      "type": "string",
      "description": "A Mexican CLABE (SPEI account), 18 digits; its verification digit is verified."
    },
    "mobileMoney": {
      "type": "object",
      "required": [
        "phone",
        "country"
      ],
      "properties": {
        "phone": {
          "type": "string",
          "description": "E.164 format, e.g. +27821234567."
        },
        "country": {
          "enum": [
            "ZA",
            "ZW",
            "MW",
            "ZM"
          ],
          "type": "string",
          "description": "ISO 3166-1 alpha-2 country of the mobile-money number: ZA, ZW, MW or ZM."
        }
      },
      "description": "A SADC mobile-money number."
    },
    "saBranchCode": {
      "type": "string",
      "description": "A South African universal branch code, 6 digits."
    },
    "usRoutingNumber": {
      "type": "string",
      "description": "A US ABA routing number, 9 digits."
    }
  }
}

{
  "title": "Assess an IBAN, BIC, US routing number, SA branch code, SADC mobile money or address before you send",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "description": "The payout file's text: pain.001 XML or a CSV with a header row."
    },
    "today": {
      "type": "string",
      "description": "Release date, YYYY-MM-DD. Defaults to today (UTC)."
    },
    "review_above": {
      "type": "number",
      "description": "Rows above this amount need a person, whatever else they pass. The company's own limit."
    }
  }
}

{
  "title": "Assess a payout file before it is released",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "chain",
    "tx"
  ],
  "properties": {
    "tx": {
      "type": "string",
      "description": "The swap's transaction hash, 0x followed by 64 hex characters."
    },
    "chain": {
      "type": "string",
      "description": "ethereum, base, arbitrum, optimism, polygon, celo or robinhood."
    }
  }
}

{
  "title": "Cost of an onchain FX swap",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "from",
    "to",
    "tenorDays"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the currency received, e.g. 'ZAR'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the currency sold forward, e.g. 'USD'."
    },
    "amount": {
      "type": "number",
      "description": "Optional notional in the from currency, to state the margin in money."
    },
    "tenorDays": {
      "type": "number",
      "description": "Days to settlement, 1 to 1095."
    },
    "quotedRate": {
      "type": "number",
      "description": "Optional. The forward rate a bank quoted (units of to per from)."
    }
  }
}

{
  "title": "Fair forward and hedge cost",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "investorCurrency",
    "amount"
  ],
  "properties": {
    "amount": {
      "type": "number",
      "description": "Amount to place, in the investor's currency."
    },
    "horizonMonths": {
      "type": "number",
      "description": "Holding period in months, default 12."
    },
    "investorCurrency": {
      "type": "string",
      "description": "ISO 4217 code the investor holds and reports in, e.g. 'ZAR'."
    }
  }
}

{
  "title": "Tokenised funds, landed in your currency",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code it must land in."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code the money leaves in."
    },
    "text": {
      "type": "string",
      "description": "The requirement in plain words."
    },
    "payer": {
      "type": "object",
      "properties": {
        "onboarded_providers": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Provider ids the payer is already onboarded with (marks that candidate ready)."
        },
        "registration_country": {
          "type": "string",
          "description": "ISO 3166 country the paying entity is registered in."
        },
        "has_local_bank_account": {
          "type": "boolean",
          "description": "Whether the payer holds a bank account in the destination country."
        }
      },
      "description": "Who is paying, so onboarding_status can be resolved per candidate instead of defaulting to onboardable-with-steps. All optional."
    },
    "amount": {
      "type": "number",
      "description": "The amount."
    },
    "value_date": {
      "type": "string",
      "description": "ISO date the money must land by."
    },
    "amount_basis": {
      "enum": [
        "source",
        "destination"
      ],
      "type": "string",
      "description": "Whether the amount leaves (source) or must land (destination). Default destination."
    },
    "max_all_in_bps": {
      "type": "number",
      "description": "The principal's own limit on all-in cost against the reference, in basis points."
    },
    "max_settlement_days": {
      "type": "number",
      "description": "The principal's own limit on settlement time."
    },
    "allowed_rail_classes": {
      "type": "array",
      "items": {
        "enum": [
          "bank",
          "specialist_fx",
          "payout_network",
          "payment_network",
          "local_rail",
          "stablecoin"
        ],
        "type": "string"
      },
      "description": "Optional. Only these rail classes may carry the payment: bank, specialist_fx, payout_network, payment_network, local_rail, stablecoin. Default: all."
    }
  }
}

{
  "title": "Structure a payment intent",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {
    "detail": {
      "enum": [
        "compact",
        "full"
      ],
      "type": "string",
      "description": "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": {
      "type": "object",
      "description": "A PaymentIntent, a flat form or { text, from }."
    },
    "map_id": {
      "type": "string",
      "description": "A map_id from an earlier map_options call: returns that stored, signed map (with expired) instead of making a new one."
    },
    "country": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "An intent compiled earlier."
    },
    "release_at": {
      "type": "string",
      "description": "Optional ISO date-time the payment will be released; default now. Sets each candidate's settlement.release_window."
    }
  }
}

{
  "title": "Map the options for an intent",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "map_id"
  ],
  "properties": {
    "x402": {
      "type": "object",
      "description": "{ accepts: PaymentRequirements[], price: { currency, amount } }."
    },
    "map_id": {
      "type": "string",
      "description": "The map_id from map_options."
    },
    "policy_id": {
      "type": "string",
      "description": "A release policy of this organisation (needs its key): supplies the limit and the map-age rule."
    },
    "ap2_mandate": {
      "type": "object",
      "description": "An AP2 intent mandate; recognised fields are read, the rest listed as unevaluable."
    },
    "constraints": {
      "type": "object",
      "description": "max_all_in_bps_vs_ref, max_settlement_days, allowed_rail_classes, disallowed_providers, must_include_provider_id, allowed_providers (restrict every row to your own already-connected panel, by provider id or name — a candidate outside it evaluates outside, never hidden; for embedding this assessment as a mandatory step inside your own already-licensed payment run, the way an EMS asks which of its own connected brokers should carry an order), corporate_only. Stablecoin risk appetite, the client's own thresholds held to each token's dated profile (/stablecoins): stablecoin_attestation_max_age_days, stablecoin_peg_min_share_within_50bps (0 to 1, last 30 days), stablecoin_peg_max_worst_bps (last 30 days), stablecoin_exit_depth_covers_amount (true), stablecoin_supervised_in (ISO codes or EU), stablecoin_no_single_key_mint_freeze (true). A fact not on record makes the row unknown, never inside."
    },
    "verifiable_intent": {
      "type": [
        "string",
        "object"
      ],
      "description": "A Verifiable Intent credential: the serialised SD-JWT, or decoded mandate objects. Amount limits and expiry are held to the intent; where the payment crosses currencies, the result says the mandate does not bound the conversion cost."
    },
    "instrument_classes_allowed": {
      "type": "array",
      "items": {
        "enum": [
          "spot",
          "forward",
          "stablecoin_rail"
        ],
        "type": "string"
      },
      "description": "Optional. Only these instruments are inside: spot, forward or stablecoin_rail. Default: all."
    }
  }
}

{
  "title": "Hold a map to constraints",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "map_id",
    "candidate_id_used",
    "realised"
  ],
  "properties": {
    "map_id": {
      "type": "string",
      "description": "The map_id of the Options Map the payment was chosen from."
    },
    "source": {
      "enum": [
        "bank_mt",
        "swift",
        "onchain_tx",
        "manual_upload"
      ],
      "type": "string",
      "description": "Where the realised figures come from: bank_mt (bank statement, MT940/950), swift (SWIFT confirmation), onchain_tx (a chain transaction) or manual_upload."
    },
    "realised": {
      "type": "object",
      "properties": {
        "failure": {
          "type": "boolean",
          "description": "true if the payment failed or was returned; default false."
        },
        "settled_at": {
          "type": "string",
          "description": "ISO 8601 date or timestamp the money landed, e.g. '2026-11-04'."
        },
        "sent_amount": {
          "type": "number",
          "description": "Amount that left, in the map's source currency."
        },
        "landed_amount": {
          "type": "number",
          "description": "Amount that landed, in the map's destination currency, after every deduction."
        },
        "all_in_bps_vs_ref": {
          "type": "number",
          "description": "All-in cost against the reference, in basis points (e.g. 85 = 0.85%), when the amounts are not given."
        }
      },
      "description": "What actually happened: sent_amount and landed_amount, or all_in_bps_vs_ref; with settled_at, and failure if it did not land."
    },
    "proof_ref": {
      "type": "string",
      "description": "Your own reference for the proof; never an account number."
    },
    "candidate_id_used": {
      "type": "string",
      "description": "The candidate_id from the map the payment went through."
    }
  }
}

{
  "title": "Reconcile what landed",
  "readOnlyHint": false,
  "openWorldHint": false,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the destination currency (what lands), e.g. 'USD'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the source currency (what leaves), e.g. 'ZAR'."
    },
    "amount": {
      "type": "number",
      "description": "Optional. Payment size for the size band, in the currency named by amount_basis."
    },
    "country": {
      "type": "string",
      "description": "Optional ISO 3166-1 alpha-2 country, e.g. CI for XOF."
    },
    "amount_basis": {
      "enum": [
        "source",
        "destination"
      ],
      "type": "string",
      "description": "Whether amount is what leaves (source) or what must land (destination). Default source."
    }
  }
}

{
  "title": "Coverage for a pair and size",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "Paying to: a two-letter country (ZW) or a currency (USD)."
    },
    "from": {
      "type": "string",
      "description": "Paying from: a two-letter country (ZA) or a currency (ZAR)."
    },
    "route": {
      "enum": [
        "bank",
        "stablecoin"
      ],
      "type": "string",
      "description": "How the payout goes; both when left out."
    },
    "currency": {
      "type": "string",
      "description": "Currency sent, when from and to are countries."
    }
  }
}

{
  "title": "Payout rules: does it apply, and when",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the destination currency (what lands), e.g. 'USD'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the source currency (what leaves), e.g. 'ZAR'."
    },
    "have": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Providers or issuers the payer already has accounts with; the result shows what they can do and what a new account adds."
    },
    "text": {
      "type": "string",
      "description": "The payment in one sentence; used instead of from/to/amount."
    },
    "amount": {
      "type": "number",
      "description": "Amount leaving, in the source currency."
    },
    "detail": {
      "enum": [
        "compact",
        "full"
      ],
      "type": "string",
      "description": "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."
    },
    "policy": {
      "type": "object",
      "properties": {
        "risk": {
          "enum": [
            "certain",
            "allow_unhedged"
          ],
          "type": "string",
          "description": "certain (default): fixed outcomes only. allow_unhedged: also considers holding the currency unhedged until the due date."
        },
        "exclude": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Provider ids or names to leave out, e.g. ['provider-a']."
        },
        "objective": {
          "enum": [
            "lowest_cost",
            "fastest"
          ],
          "type": "string",
          "description": "What decides the selected route: lowest_cost (total cost) or fastest (time to land)."
        },
        "deadline_days": {
          "type": "number",
          "description": "Days from today by which the money must land; routes that cannot are left out."
        },
        "max_all_in_bps": {
          "type": "number",
          "description": "Maximum all-in cost against the official rate, in basis points (e.g. 150 = 1.5%)."
        },
        "require_licence": {
          "type": "boolean",
          "description": "true: only routes with a licence on record. Default false."
        },
        "include_estimates": {
          "type": "boolean",
          "description": "true also selects among routes priced by estimate. Default false: measured payments or published prices only."
        }
      },
      "description": "Optional. The payer's own routing policy; overrides what is read from text."
    },
    "repeat": {
      "enum": [
        "weekly",
        "monthly"
      ],
      "type": "string",
      "description": "With remember and due_date: the payment repeats; due_date is the first cycle. Monthly cycles keep the day of month (31st: last day of shorter months). One reminder per cycle, before the last day to release through the selected route."
    },
    "deliver": {
      "type": "number",
      "description": "Amount to deliver on the due date, destination currency."
    },
    "lock_at": {
      "type": "number",
      "description": "With remember: mark the day locking the rate needs this much or less, source currency."
    },
    "due_date": {
      "type": "string",
      "description": "YYYY-MM-DD the money must land; adds routing across time: pay now, forward, convert and park, hold unhedged."
    },
    "remember": {
      "type": "boolean",
      "description": "Keep the intent and reprice it daily until it lands; returns remembered.intent_id."
    },
    "repeat_count": {
      "type": "number",
      "description": "With repeat: number of cycles, the first included."
    },
    "repeat_until": {
      "type": "string",
      "description": "With repeat: YYYY-MM-DD, last date a cycle may fall on."
    },
    "nudge_lead_days": {
      "type": "number",
      "description": "With repeat: banking days before the release-by date to send the reminder (default 2)."
    },
    "your_quote_landed": {
      "type": "number",
      "description": "What the payer's current quote would land, in the destination currency."
    }
  }
}

{
  "title": "Route an intent",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "intent_id"
  ],
  "properties": {
    "intent_id": {
      "type": "string",
      "description": "The remembered intent (remembered.intent_id from route_intent with remember: true)."
    }
  }
}

{
  "title": "Remembered intent status",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "token",
    "chain_id",
    "from",
    "to",
    "amount"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "The recipient's address on the chain it receives on (0x, or T... on Tron), or your own deposit address at an off-ramp."
    },
    "from": {
      "type": "string",
      "description": "The paying wallet's address: 0x on EVM chains, T... (base58check) on Tron."
    },
    "rules": {
      "type": "object",
      "description": "Inline rules when no profile is used: max_per_payment_usd, approval_above_usd, daily_limit_usd, monthly_limit_usd, allowed_recipients, allowed_chains."
    },
    "token": {
      "enum": [
        "USDC",
        "USDT"
      ],
      "type": "string",
      "description": "The stablecoin paid from the wallet: USDC or USDT."
    },
    "amount": {
      "type": "number",
      "description": "Amount to pay, in token units (1 = one USDC or USDT), greater than zero."
    },
    "map_id": {
      "type": "string",
      "description": "The map_id from discover_payment or map_options. The map must not have expired."
    },
    "private": {
      "type": "boolean",
      "description": "Pay privately through NEAR Intents' confidential mode: one transfer to a deposit address for your wallet to sign; settles in full or refunds to your wallet. The quote's signature and correlation id go into the signed record. Read progress with private_payment_status."
    },
    "chain_id": {
      "type": "number",
      "description": "8453 Base, 42161 Arbitrum, 10 Optimism, 137 Polygon, 56 BNB Chain, 728126428 Tron (USDT only)."
    },
    "to_token": {
      "enum": [
        "USDC",
        "USDT"
      ],
      "type": "string",
      "description": "Optional. The stablecoin the recipient receives, when it differs from token: USDC or USDT."
    },
    "profile_id": {
      "type": "string",
      "description": "prof_… from payment_controls; applies the organisation's budgets and approval line."
    },
    "to_chain_id": {
      "type": "number",
      "description": "The chain the recipient receives on, when it differs from chain_id. To or from Tron (728126428) needs private: true."
    },
    "candidate_id": {
      "type": "string",
      "description": "The stablecoin candidate in that map this payment takes. Bank candidates are sent by your bank or provider, not prepared here."
    },
    "destination_currency": {
      "type": "string",
      "description": "The local currency the money is for, so local stablecoin rules are assessed, e.g. ZAR."
    }
  }
}

{
  "title": "Prepare a stablecoin payment within the rules",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "prepare_id",
    "tx_hash"
  ],
  "properties": {
    "tx_hash": {
      "type": "string",
      "description": "The transaction hash your wallet broadcast: 0x plus 64 hex characters on EVM chains, 64 hex characters on Tron."
    },
    "contribute": {
      "type": "boolean",
      "description": "True adds one anonymised row (token, network, month, size band) to SwapEazi's cost research."
    },
    "prepare_id": {
      "type": "string",
      "description": "The prepare_id returned by prepare_payment."
    }
  }
}

{
  "title": "Confirm a prepared payment on chain",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "deposit_address"
  ],
  "properties": {
    "deposit_address": {
      "type": "string",
      "description": "The deposit_address from the payment's quote_proof (prepare_payment with private: true)."
    }
  }
}

{
  "title": "Where a private payment stands",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "approval_id": {
      "type": "string",
      "description": "rapr_… returned by prepare_payment when a person must approve."
    }
  }
}

{
  "title": "Spend profiles, approvals and audit trail",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "intent_id"
  ],
  "properties": {
    "intent_id": {
      "type": "string",
      "description": "pi_… from POST /api/v1/cases."
    }
  }
}

{
  "title": "Payment case and Evidence Passport",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "approval_id"
  ],
  "properties": {
    "approval_id": {
      "type": "string",
      "description": "apr_… (or aprd_… for a demo item), from POST /api/v1/agent/run with policy_id."
    }
  }
}

{
  "title": "Approval status",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {}
}

{
  "title": "Retired: request an introduction",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "days": {
      "type": "number",
      "description": "Look-back window, 1 to 365. Default 90."
    },
    "kind": {
      "type": "string",
      "description": "Optional comma-separated kinds: route_launch, route_exit, licence_granted, licence_revoked, rule_change, devaluation, limit_change, outage, partnership, other."
    },
    "pair": {
      "type": "string",
      "description": "Six letters, e.g. NGNCNY. Matches either currency or the exact corridor."
    },
    "limit": {
      "type": "number",
      "description": "Events returned, 1 to 100. Default 25."
    },
    "currency": {
      "type": "string",
      "description": "One ISO code, e.g. NGN, when no pair is given."
    }
  }
}

{
  "title": "Corridor news for a pair or currency",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "Destination currency, e.g. ZAR."
    },
    "from": {
      "type": "string",
      "description": "Source currency, e.g. USDT."
    },
    "amount": {
      "type": "number",
      "description": "Amount in the source currency. Default 10000."
    },
    "corridor": {
      "type": "string",
      "description": "Instead of from and to: USDT-ZAR."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    }
  }
}

{
  "title": "Public prices for a corridor, each with a Rate Receipt",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "rr_... from price_routes."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    }
  }
}

{
  "title": "Read one stored Rate Receipt",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    }
  }
}

{
  "title": "Route standing for every corridor",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "agent_id",
    "max_per_payment",
    "max_per_period",
    "period",
    "currencies_allowed",
    "corridors_allowed",
    "rails_allowed",
    "approver_person_id",
    "expires_at"
  ],
  "properties": {
    "period": {
      "enum": [
        "day",
        "week",
        "month"
      ],
      "type": "string",
      "description": "The window max_per_period applies to: day, week or month."
    },
    "agent_id": {
      "type": "string",
      "description": "Your own id for the agent this mandate covers, e.g. 'ap-agent-1'."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "expires_at": {
      "type": "string",
      "description": "ISO 8601, in the future."
    },
    "rails_allowed": {
      "type": "array",
      "items": {
        "enum": [
          "bank",
          "provider",
          "stablecoin_wallet"
        ],
        "type": "string"
      },
      "description": "Rails the agent may use: bank, provider, stablecoin_wallet."
    },
    "max_per_period": {
      "type": "object",
      "description": "{ amount, currency }"
    },
    "max_per_payment": {
      "type": "object",
      "description": "{ amount, currency }"
    },
    "corridors_allowed": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "e.g. USDT-ZAR"
    },
    "approver_person_id": {
      "type": "string",
      "description": "The person who approves. An agent cannot approve alone."
    },
    "currencies_allowed": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "ISO 4217 codes the agent may pay in, e.g. ['ZAR', 'USD']."
    },
    "max_cost_above_official_pct": {
      "type": [
        "number",
        "null"
      ],
      "description": "Optional. Most a payment may cost above the official rate, in percent (e.g. 1.5); null for no cap."
    }
  }
}

{
  "title": "Create a per-agent spend mandate",
  "readOnlyHint": false,
  "openWorldHint": false,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "man_..."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "mandate_id": {
      "type": "string",
      "description": "Same as id."
    }
  }
}

{
  "title": "Read one spend mandate",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "mandate_id",
    "amount",
    "currency",
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the destination currency, e.g. 'ZAR'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the source currency, e.g. 'USDT'; with to, forms the corridor (e.g. USDT-ZAR)."
    },
    "rail": {
      "enum": [
        "bank",
        "provider",
        "stablecoin"
      ],
      "type": "string",
      "description": "Optional. The rail the payment would use: bank, provider or stablecoin."
    },
    "amount": {
      "type": "number",
      "description": "The payment amount, in currency, greater than zero."
    },
    "agent_id": {
      "type": "string",
      "description": "Optional. The agent making the payment; must match the mandate's agent."
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 code of amount, e.g. 'USD'."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "mandate_id": {
      "type": "string",
      "description": "The mandate's id, from create_mandate."
    },
    "cost_above_official_pct": {
      "type": [
        "number",
        "null"
      ],
      "description": "Null when the gap to the official rate is not on record. Never treated as zero."
    }
  }
}

{
  "title": "Hold one payment against a mandate",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "payee_name",
    "from",
    "to",
    "amount_receive",
    "deadline"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code the payee receives, e.g. 'NGN'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code the business pays from, e.g. 'USD'."
    },
    "deadline": {
      "type": "string",
      "description": "YYYY-MM-DD"
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "payee_name": {
      "type": "string",
      "description": "The payee's name, e.g. 'Lagos Steel Ltd'."
    },
    "customer_id": {
      "type": "string",
      "description": "Optional. Your own id for the customer, so its negotiated rate on record is included."
    },
    "amount_receive": {
      "type": "number",
      "description": "What the payee must receive, in the to currency, greater than zero."
    }
  }
}

{
  "title": "State what the business owes",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "intent_id",
    "decision",
    "person_name",
    "person_role"
  ],
  "properties": {
    "decision": {
      "enum": [
        "approved",
        "rejected"
      ],
      "type": "string",
      "description": "approved or rejected."
    },
    "intent_id": {
      "type": "string",
      "description": "The payment intent's id, from payment_intent."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "person_name": {
      "type": "string",
      "description": "Full name of the person deciding, e.g. 'Thandi Nkosi'. An agent cannot decide alone."
    },
    "person_role": {
      "type": "string",
      "description": "That person's role, e.g. 'Finance Director'."
    }
  }
}

{
  "title": "A named person approves or rejects a proposal",
  "readOnlyHint": false,
  "openWorldHint": false,
  "idempotentHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "description": "With run_id: the payment's purpose as the rail records it, e.g. 'other' (default)."
    },
    "run_id": {
      "type": "string",
      "description": "Instead of intent_id: the payment run (pr_...) holding an approved payment to send."
    },
    "intent_id": {
      "type": "string",
      "description": "An approved payment intent (from payment_intent and decide_intent): returns its instruction for your rail."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "channel_id": {
      "type": "string",
      "description": "With run_id: the rail's payout channel id for this payment (Yellow Card channelId)."
    },
    "network_id": {
      "type": "string",
      "description": "With run_id: the rail's id for the payee's bank or mobile-money network (Yellow Card networkId)."
    },
    "payment_id": {
      "type": "string",
      "description": "With run_id: the approved payment in the run, e.g. 'p_001'."
    },
    "account_type": {
      "enum": [
        "bank",
        "momo"
      ],
      "type": "string",
      "description": "With run_id: bank (default) or momo (mobile money)."
    },
    "connection_id": {
      "type": "string",
      "description": "With run_id: your connected rail account (from connect_rail_account) to send through."
    },
    "account_number": {
      "type": "string",
      "description": "The payee's full account number as approved; SwapEazi keeps only its last four characters and matches this against the approved instruction."
    }
  }
}

{
  "title": "Handoff to your rail",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "rail",
    "api_key",
    "secret",
    "cap_per_payment"
  ],
  "properties": {
    "env": {
      "enum": [
        "sandbox",
        "production"
      ],
      "type": "string",
      "description": "sandbox (default) or production; production sending stays off unless the deployment enables it."
    },
    "rail": {
      "enum": [
        "yellowcard"
      ],
      "type": "string",
      "description": "The rail: yellowcard."
    },
    "label": {
      "type": "string",
      "description": "Optional. Your name for this connection, up to 80 characters."
    },
    "secret": {
      "type": "string",
      "description": "Your API secret at the rail. Encrypted at rest; never shown."
    },
    "sender": {
      "type": "object",
      "description": "Optional. The sending business as the rail needs it: { name, country, phone, address, email, idType, idNumber, businessId, businessName }."
    },
    "api_key": {
      "type": "string",
      "description": "Your API key at the rail. Encrypted at rest; only its last four characters are ever shown."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "cap_per_payment": {
      "type": "object",
      "required": [
        "value",
        "currency"
      ],
      "properties": {
        "value": {
          "type": "number",
          "description": "The cap, in cap_per_payment.currency, greater than 0 and at most 10,000,000."
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 code of the cap, e.g. 'USD'."
        }
      },
      "description": "Required. The most any one payment through this connection may be: { value, currency }; a payment in another currency is refused."
    }
  }
}

{
  "title": "Connect your own rail account",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "access_key": {
      "type": "string",
      "description": "The router key (rk_...) the accounts were connected with, if not sent as a Bearer header."
    }
  }
}

{
  "title": "Your connected rail accounts",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "connection_id"
  ],
  "properties": {
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "connection_id": {
      "type": "string",
      "description": "The connected rail account to delete (from list_rail_accounts)."
    }
  }
}

{
  "title": "Remove a connected rail account",
  "readOnlyHint": false,
  "openWorldHint": false,
  "idempotentHint": true,
  "destructiveHint": true
}

{
  "type": "object",
  "required": [
    "party",
    "name",
    "contact"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "Rails only, with rate: ISO 4217 destination currency, e.g. 'ZAR'."
    },
    "from": {
      "type": "string",
      "description": "Rails only, with rate: ISO 4217 source currency of the published rate, e.g. 'USD'."
    },
    "name": {
      "type": "string",
      "description": "The joining organisation's or agent's name."
    },
    "rate": {
      "type": "number",
      "description": "Rails only: one published rate, destination units per source unit, e.g. 18.25."
    },
    "party": {
      "enum": [
        "business",
        "rail",
        "agent"
      ],
      "type": "string",
      "description": "Who is joining: business, rail or agent."
    },
    "contact": {
      "type": "string",
      "description": "A work email address to reach the joining party."
    },
    "rail_kind": {
      "type": "string",
      "description": "Rails only: bank, otc, ramp, psp or amm."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "quote_feed": {
      "enum": [
        "api_key",
        "oauth"
      ],
      "type": "string",
      "description": "Rails only, optional: how the quote feed connects: api_key or oauth."
    }
  }
}

{
  "title": "Join the network",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the destination currency (what lands), e.g. 'USD'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the source currency (what leaves), e.g. 'ZAR'."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    }
  }
}

{
  "title": "Where a rail's published price sits",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "customer_id",
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the destination currency (what lands), e.g. 'USD'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the source currency (what leaves), e.g. 'ZAR'."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "customer_id": {
      "type": "string",
      "description": "Your own id for the customer whose negotiated deal is compared, e.g. 'acme'."
    }
  }
}

{
  "title": "Dated comparisons against a customer's bank deal",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "description": "YYYY-MM-DD. Default today (UTC)."
    }
  }
}

{
  "title": "Market-observed gap between public adverts and the official rate",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the destination currency (what lands), e.g. 'USD'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the source currency (what leaves), e.g. 'ZAR'."
    },
    "amount": {
      "type": "number",
      "description": "Amount leaving, in the source currency."
    },
    "corridor": {
      "type": "string",
      "description": "e.g. EUR-ZMW instead of from and to."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    }
  }
}

{
  "title": "Corridor rates and routes",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "description": "Amount, in currency (default the source currency)."
    },
    "weights": {
      "type": "object",
      "description": "Your own scoring weights: { total_cost, speed, reliability, liquidity, compliance }, non-negative, normalised to 1."
    },
    "currency": {
      "type": "string",
      "description": "The currency of amount: the source currency, or the destination one (then it is what the supplier receives)."
    },
    "due_date": {
      "type": "string",
      "description": "YYYY-MM-DD: a route that cannot settle by then is not eligible."
    },
    "priority": {
      "enum": [
        "cost",
        "speed",
        "balanced"
      ],
      "type": "string",
      "description": "Sets the default scoring weights. Default balanced."
    },
    "supplier": {
      "type": "string",
      "description": "Optional. The supplier's name as on the invoice, e.g. 'Lusaka Copper Supplies Ltd'; echoed in the analysis."
    },
    "reference": {
      "type": "string",
      "description": "Optional. Your invoice or payment reference, e.g. 'INV-2207'; echoed in the analysis."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header: names the routes and is not counted."
    },
    "analysis_id": {
      "type": "string",
      "description": "Read a kept analysis (pa_...) instead of making a new one."
    },
    "invoice_text": {
      "type": "string",
      "description": "Paste the invoice or a sentence (e.g. 'Invoice INV-2207, Lusaka Copper Supplies Ltd, Zambia. Amount due: EUR 80,000. Due 2026-11-20'). Or the fields below."
    },
    "source_currency": {
      "type": "string",
      "description": "ISO code you pay from, e.g. EUR or ZAR."
    },
    "existing_provider": {
      "type": "object",
      "description": "Your current provider: { provider, kind: quote | entered_rate | past_payment, rate (destination per source unit) or landed_amount, fees: { transaction, intermediary, payout } in the source currency, fees_deducted_destination, quoted_at, valid_until }."
    },
    "beneficiary_amount": {
      "type": "number",
      "description": "What the supplier must receive, in the destination currency (instead of amount)."
    },
    "destination_country": {
      "type": "string",
      "description": "ISO 3166 alpha-2 or name, e.g. ZM or Mozambique."
    },
    "destination_currency": {
      "type": "string",
      "description": "ISO code the supplier is paid in, e.g. ZMW. Or destination_country."
    }
  }
}

{
  "title": "Calculate what a payment costs",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "description": "Amount, in currency (default the source currency)."
    },
    "weights": {
      "type": "object",
      "description": "Your own scoring weights: { total_cost, speed, reliability, liquidity, compliance }, non-negative, normalised to 1."
    },
    "currency": {
      "type": "string",
      "description": "The currency of amount: the source currency, or the destination one (then it is what the supplier receives)."
    },
    "due_date": {
      "type": "string",
      "description": "YYYY-MM-DD: a route that cannot settle by then is not eligible."
    },
    "priority": {
      "enum": [
        "cost",
        "speed",
        "balanced"
      ],
      "type": "string",
      "description": "Sets the default scoring weights. Default balanced."
    },
    "supplier": {
      "type": "string",
      "description": "Optional. The supplier's name as on the invoice, e.g. 'Lusaka Copper Supplies Ltd'; echoed in the analysis."
    },
    "reference": {
      "type": "string",
      "description": "Optional. Your invoice or payment reference, e.g. 'INV-2207'; echoed in the analysis."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header: names the routes and is not counted."
    },
    "analysis_id": {
      "type": "string",
      "description": "Read a kept analysis (pa_...) instead of making a new one."
    },
    "invoice_text": {
      "type": "string",
      "description": "Paste the invoice or a sentence (e.g. 'Invoice INV-2207, Lusaka Copper Supplies Ltd, Zambia. Amount due: EUR 80,000. Due 2026-11-20'). Or the fields below."
    },
    "source_currency": {
      "type": "string",
      "description": "ISO code you pay from, e.g. EUR or ZAR."
    },
    "existing_provider": {
      "type": "object",
      "description": "Your current provider: { provider, kind: quote | entered_rate | past_payment, rate (destination per source unit) or landed_amount, fees: { transaction, intermediary, payout } in the source currency, fees_deducted_destination, quoted_at, valid_until }."
    },
    "beneficiary_amount": {
      "type": "number",
      "description": "What the supplier must receive, in the destination currency (instead of amount)."
    },
    "destination_country": {
      "type": "string",
      "description": "ISO 3166 alpha-2 or name, e.g. ZM or Mozambique."
    },
    "destination_currency": {
      "type": "string",
      "description": "ISO code the supplier is paid in, e.g. ZMW. Or destination_country."
    }
  }
}

{
  "title": "Compare payment providers for one payment",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "amount"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the destination currency (what lands), e.g. 'USD'."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the source currency (what leaves), e.g. 'ZAR'."
    },
    "pair": {
      "type": "string",
      "description": "e.g. EUR-ZMW. Or from and to."
    },
    "amount": {
      "type": "number",
      "description": "Ticket size, in the from currency unless amount_currency says otherwise."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "amount_currency": {
      "type": "string",
      "description": "The from or the to currency. Default from."
    }
  }
}

{
  "title": "Liquidity at this payment's size",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "Instead of payables: a payout CSV or pain.001 text."
    },
    "sample": {
      "type": "boolean",
      "description": "true: the built-in sample run (synthetic, labelled), no key needed."
    },
    "payables": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "[{ reference, payee: { name, iban?, bic?, account_number?, routing_number?, branch_code?, country? }, amount, currency, due_date?, rail?: bank | provider | stablecoin, via?, wallet? }]"
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header."
    },
    "source_currency": {
      "type": "string",
      "description": "The currency the business pays from, e.g. ZAR."
    }
  }
}

{
  "title": "Prepare payment instructions",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "required": [
    "run_id"
  ],
  "properties": {
    "run_id": {
      "type": "string",
      "description": "The payment run (pr_...), or pr_sample."
    },
    "access_key": {
      "type": "string",
      "description": "The router key that made the run."
    }
  }
}

{
  "title": "What needs a person's approval",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "run_id",
    "payment_id"
  ],
  "properties": {
    "run_id": {
      "type": "string",
      "description": "The payment run (pr_...), or pr_sample."
    },
    "account": {
      "type": "string",
      "description": "The payee account the person approved, to match."
    },
    "access_key": {
      "type": "string",
      "description": "The router key that made the run."
    },
    "payment_id": {
      "type": "string",
      "description": "The approved payment in the run, e.g. 'p_001'."
    },
    "connection_id": {
      "type": "string",
      "description": "Your connected rail account to send through (from connect_rail_account). Omit to read the submission's status."
    }
  }
}

{
  "title": "Submit an approved payment (sandbox)",
  "readOnlyHint": false,
  "openWorldHint": true,
  "idempotentHint": true,
  "destructiveHint": true
}

{
  "type": "object",
  "required": [
    "run_id"
  ],
  "properties": {
    "run_id": {
      "type": "string",
      "description": "The payment run (pr_...), or pr_sample."
    },
    "access_key": {
      "type": "string",
      "description": "The router key that made the run."
    }
  }
}

{
  "title": "Track a payment to settlement",
  "readOnlyHint": true,
  "openWorldHint": false
}

{
  "type": "object",
  "required": [
    "sourceCurrency",
    "destinationCurrency",
    "inputAmount",
    "netLandedFiat"
  ],
  "properties": {
    "midSpot": {
      "type": "number",
      "description": "Optional. Your own mid, destination units per source unit. Omit to use SwapEazi's reference."
    },
    "settledOn": {
      "type": "string",
      "description": "ISO date the payment settled. Omit it (or pass a future date) for a quote not yet accepted: it is measured against today's reference."
    },
    "inputAmount": {
      "type": "number",
      "description": "Amount sent, in the source currency.",
      "exclusiveMinimum": 0
    },
    "netLandedFiat": {
      "type": "number",
      "description": "Amount that landed or will land, in the destination currency, after every deduction.",
      "exclusiveMinimum": 0
    },
    "sourceCurrency": {
      "type": "string",
      "description": "ISO 4217 code the payment is funded in, e.g. 'GBP'."
    },
    "destinationCurrency": {
      "type": "string",
      "description": "ISO 4217 code the payment lands in, e.g. 'EUR'."
    }
  }
}

{
  "title": "Landed cost of a payment",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "required": [
    "from",
    "to",
    "routes"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "ISO 4217 code of the currency that landed, e.g. 'KES'."
    },
    "date": {
      "type": "string",
      "description": "Optional payment date, YYYY-MM-DD. Defaults to today (a quote)."
    },
    "from": {
      "type": "string",
      "description": "ISO 4217 code of the currency that left, e.g. 'ZAR'."
    },
    "sent": {
      "type": "number",
      "description": "Optional amount sent, shared by every route that does not state its own."
    },
    "routes": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "landed"
        ],
        "properties": {
          "fee": {
            "type": "number",
            "description": "Optional. Fees charged on top for this route, in the from currency."
          },
          "sent": {
            "type": "number",
            "description": "Optional. Amount this route sent, in the from currency; defaults to the shared sent."
          },
          "label": {
            "type": "string",
            "description": "Your name for this route, e.g. 'Bank wire' or 'USDC via ramp'."
          },
          "landed": {
            "type": "number",
            "description": "Amount this route landed, in the to currency, after every deduction."
          }
        }
      },
      "description": "Two to four routes. Each: label, landed (in the to currency), and optionally sent and fee (both in the from currency)."
    },
    "annualVolume": {
      "type": "number",
      "description": "Optional yearly volume on this route in the from currency, to state the gap per year."
    }
  }
}

{
  "title": "Bank or stablecoin: compare routes",
  "readOnlyHint": true,
  "openWorldHint": true
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "description": "Amount, in currency (default the source currency)."
    },
    "weights": {
      "type": "object",
      "description": "Your own scoring weights: { total_cost, speed, reliability, liquidity, compliance }, non-negative, normalised to 1."
    },
    "currency": {
      "type": "string",
      "description": "The currency of amount: the source currency, or the destination one (then it is what the supplier receives)."
    },
    "due_date": {
      "type": "string",
      "description": "YYYY-MM-DD: a route that cannot settle by then is not eligible."
    },
    "priority": {
      "enum": [
        "cost",
        "speed",
        "balanced"
      ],
      "type": "string",
      "description": "Sets the default scoring weights. Default balanced."
    },
    "supplier": {
      "type": "string",
      "description": "Optional. The supplier's name as on the invoice, e.g. 'Lusaka Copper Supplies Ltd'; echoed in the analysis."
    },
    "reference": {
      "type": "string",
      "description": "Optional. Your invoice or payment reference, e.g. 'INV-2207'; echoed in the analysis."
    },
    "access_key": {
      "type": "string",
      "description": "A router key (rk_...), if not sent as a Bearer header: names the routes and is not counted."
    },
    "analysis_id": {
      "type": "string",
      "description": "Read a kept analysis (pa_...) instead of making a new one."
    },
    "invoice_text": {
      "type": "string",
      "description": "Paste the invoice or a sentence (e.g. 'Invoice INV-2207, Lusaka Copper Supplies Ltd, Zambia. Amount due: EUR 80,000. Due 2026-11-20'). Or the fields below."
    },
    "source_currency": {
      "type": "string",
      "description": "ISO code you pay from, e.g. EUR or ZAR."
    },
    "existing_provider": {
      "type": "object",
      "description": "Your current provider: { provider, kind: quote | entered_rate | past_payment, rate (destination per source unit) or landed_amount, fees: { transaction, intermediary, payout } in the source currency, fees_deducted_destination, quoted_at, valid_until }."
    },
    "beneficiary_amount": {
      "type": "number",
      "description": "What the supplier must receive, in the destination currency (instead of amount)."
    },
    "destination_country": {
      "type": "string",
      "description": "ISO 3166 alpha-2 or name, e.g. ZM or Mozambique."
    },
    "destination_currency": {
      "type": "string",
      "description": "ISO code the supplier is paid in, e.g. ZMW. Or destination_country."
    }
  }
}

{
  "title": "FX leakage on a payment",
  "readOnlyHint": true,
  "openWorldHint": true
}