list_gift_card_merchants

MCP tool list_gift_card_merchants, called with tools/call on https://api.envoy.money/mcp (Streamable HTTP).

List merchants selling gift cards. Only a listed merchant can be bought; Envoy picks from amounts or amount_range for the cart total. discount_percent is an indicative product maximum; null means none reported. Say "up to". The actual purchase quote is authoritative; until available, payable is unknown. redeem_at says where the gift card is used: account — add it to the user's account balance on the merchant site, then check out normally; checkout — enter it at the merchant's payment step; null — not known yet. To buy, call start_purchase with rail "gift_card".

The text content is a plain-English briefing, then one line of JSON with the slim agent data. structuredContent holds that same slim data. isError is true when the call failed and changed nothing. Diagnostics for support are in _meta["money.envoy/support"]; they are not for the model. Tool annotations describe effects; they do not grant permission. The HTTP API returns the full envelope: see the API reference page.

Input

Send an empty JSON object, {}.

Unknown fields are rejected. The exact input schema is on the schemas page.

Synthetic request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_gift_card_merchants",
    "arguments": {}
  }
}

Success data

The text content opens with a briefing: one to three sentences for the user, then What to do: for the agent. Tell the user the first part in your own words and do what What to do says. One JSON line follows with these fields. Pass next.args unchanged to next.tool. Never show the JSON line, ids or codes to the user. Outputs may gain fields, so ignore ones you do not recognize.

Synthetic result

Example synthetic-compatible-payload (synthetic data, the MCP text content; JSON is formatted here for reading but arrives on one line):

1 gift-card merchant available. Only a listed merchant can be bought. Each lists the gift card amounts it sells, or a range of any whole rupee; Envoy buys the gift card for the cart total when the purchase starts. discount_percent is an indicative product maximum: say "up to"; null means no discount is reported. The actual purchase quote is authoritative; until available, payable is unknown. Do not infer price from payment method or card ownership.

What to do: Offer only a listed merchant. To buy its gift card, call start_purchase with rail "gift_card"; without it Envoy may pay with a one-time card instead. Say any discount is "up to", never a promise. Never promise an unlisted merchant.

{
  "merchants": [
    {
      "name": "shop.example.test",
      "domain": "shop.example.test",
      "amounts": [
        {
          "minor": 50000,
          "currency": "INR",
          "display": "₹500.00"
        },
        {
          "minor": 100000,
          "currency": "INR",
          "display": "₹1,000.00"
        }
      ],
      "amount_range": null,
      "discount_percent": 2.5,
      "redeem_at": "checkout"
    }
  ]
}

Errors

A failure sets isError to true and changes nothing. The briefing says what happened and what to do; retry and fix in the JSON line say whether and how to retry. Branch on those, not on a code: these common codes appear only in _meta["money.envoy/support"], for support. See all error codes for the complete contract list.

Downloads

OpenAPI · MCP catalog · Synthetic examples · Schemas