docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "aspen",
  "name": "Request Network Docs",
  "colors": {
    "primary": "#01B089",
    "light": "#59F9D6",
    "dark": "#01513B"
  },
  "appearance": {
    "default": "dark"
  },
  "background": {
    "decoration": "gradient",
    "color": {
      "light": "#FFFFFF",
      "dark": "#001912"
    }
  },
  "favicon": "/favicon.svg",
  "metadata": {
    "timestamp": true
  },
  "fonts": {
    "heading": {
      "family": "Montserrat"
    },
    "body": {
      "family": "Montserrat",
      "weight": 500
    }
  },
  "thumbnails": {
    "appearance": "dark"
  },
  "redirects": [
    {
      "source": "/api-features/no-code-payment-links",
      "destination": "/use-cases/no-code-payment-links"
    },
    {
      "source": "/api-features/programmatic-payment-links",
      "destination": "/use-cases/programmatic-payment-links"
    },
    {
      "source": "/api-features/authentication",
      "destination": "/api-reference/authentication"
    },
    {
      "source": "/advanced/introduction-to-the-request-protocol",
      "destination": "/resources/lifecycle-of-a-request"
    },
    {
      "source": "/advanced/introduction-to-the-request-protocol/advanced-logic",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/introduction-to-the-request-protocol/data-access",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/introduction-to-the-request-protocol/request-logic",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/introduction-to-the-request-protocol/storage",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/introduction-to-the-request-protocol/transaction",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/protocol-overview",
      "destination": "/resources/lifecycle-of-a-request"
    },
    {
      "source": "/advanced/protocol-overview/contracts",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/protocol-overview/how-payment-networks-work",
      "destination": "/resources/lifecycle-of-a-request"
    },
    {
      "source": "/advanced/protocol-overview/private-requests-using-encryption",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/get-started",
      "destination": "/api-setup/getting-started"
    },
    {
      "source": "/advanced/request-network-sdk/get-started/installation",
      "destination": "/api-setup/getting-started"
    },
    {
      "source": "/advanced/request-network-sdk/get-started/quickstart-browser",
      "destination": "/api-setup/getting-started"
    },
    {
      "source": "/advanced/request-network-sdk/get-started/request-node-gateways",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/get-started/sdk-injector",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/epk-decryption/ethereumprivatekeydecryptionprovider",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/epk-signature",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/payment-processor",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/payment-processor/payrequest",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/iidentity",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/irequestdatawithevents",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/paymentreferencecalculator",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/request/cancel",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/request/getdata",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/request/increaseexpectedamountrequest",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/request/refresh",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/request/waitforconfirmation",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/requestnetwork",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/request-client.js/requestnetwork/fromrequestid",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-api-reference/web3-signature",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-demo-apps",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-demo-apps/components",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-demo-apps/components/add-stakeholder",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-demo-apps/components/create-invoice-form",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-demo-apps/components/initializeRN",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-demo-apps/request-checkout",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-demo-apps/request-invoicing",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/encryption-and-decryption",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/encryption-and-decryption/handle-encryption-with-a-web3-wallet",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/encryption-and-decryption/handling-encryption-with-the-js-library",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/encryption-and-decryption/share-an-encrypted-request",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/mobile-using-expo",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment",
      "destination": "/api-features/payment-types-overview"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/batch-payment",
      "destination": "/api-features/batch-payments"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/conversion-request",
      "destination": "/api-features/conversion-payments"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/declarative-request",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/escrow-request",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/hinkal-private-payments",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/meta-payments",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/native-payment",
      "destination": "/api-features/standard-payments"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/pay-through-a-proxy-contract-with-a-multisig",
      "destination": "/api-features/safe-multisig-payments"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/shared",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/single-request-forwarder",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/streaming-request",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/swap-to-pay-request",
      "destination": "/api-features/crosschain-payments"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/payment/transferable-receivable-payment",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/request-client",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/request-client/retrieve-a-request",
      "destination": "/api-features/query-requests"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/request-client/support-a-new-currency",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/advanced/request-network-sdk/sdk-guides/request-client/updating-a-request",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/api-setup/components/create-payment",
      "destination": "/api-setup/getting-started"
    },
    {
      "source": "/development/guides/online-payments",
      "destination": "/use-cases/programmatic-payment-links"
    },
    {
      "source": "/development/protocol",
      "destination": "/resources/lifecycle-of-a-request"
    },
    {
      "source": "/docs/guides/1-first-request",
      "destination": "/use-cases/quickstart"
    },
    {
      "source": "/docs/guides/7-protocol/5-flows",
      "destination": "/resources/lifecycle-of-a-request"
    },
    {
      "source": "/general/lifecycle-of-a-request",
      "destination": "/resources/lifecycle-of-a-request"
    },
    {
      "source": "/general/request-network-token-list",
      "destination": "/resources/token-list"
    },
    {
      "source": "/general/request-scan",
      "destination": "https://scan.request.network"
    },
    {
      "source": "/general/supported-chains",
      "destination": "/resources/supported-chains-and-currencies"
    },
    {
      "source": "/general/supported-chains/smart-contract-addresses",
      "destination": "/resources/supported-chains-and-currencies"
    },
    {
      "source": "/get-started/request-node-gateways",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/learn-request-network/introduction-to-the-request-protocol",
      "destination": "/resources/lifecycle-of-a-request"
    },
    {
      "source": "/payments",
      "destination": "/api-features/payment-types-overview"
    },
    {
      "source": "/request-network-api/api-portal-manage-api-keys-and-webhooks",
      "destination": "/api-features/client-id-management"
    },
    {
      "source": "/request-network-api/batch-payments",
      "destination": "/api-features/batch-payments"
    },
    {
      "source": "/request-network-api/components/view-payments",
      "destination": "/api-features/query-payments"
    },
    {
      "source": "/request-network-api/create-and-pay-requests",
      "destination": "/api-features/create-requests"
    },
    {
      "source": "/request-network-api/crosschain-payments",
      "destination": "/api-features/crosschain-payments"
    },
    {
      "source": "/request-network-api/crypto-to-fiat-payments",
      "destination": "/api-features/crypto-to-fiat-payments"
    },
    {
      "source": "/request-network-api/easyinvoice-api-demo-app",
      "destination": "/use-cases/quickstart"
    },
    {
      "source": "/request-network-api/fees",
      "destination": "/api-features/fee-breakdowns"
    },
    {
      "source": "/request-network-api/integration-tutorial",
      "destination": "/api-setup/integration-tutorial"
    },
    {
      "source": "/request-network-api/migrate-to-v2",
      "destination": "/api-setup/getting-started"
    },
    {
      "source": "/request-network-api/payment-detection",
      "destination": "/api-features/payment-detection"
    },
    {
      "source": "/request-network-api/recurring-payments",
      "destination": "/api-features/recurring-payments"
    },
    {
      "source": "/request-network-api/supported-chains-and-currencies",
      "destination": "/resources/supported-chains-and-currencies"
    },
    {
      "source": "/sdk-guides/payment/native-payment",
      "destination": "/api-features/standard-payments"
    },
    {
      "source": "/sdk-guides/request-client/updating-a-request",
      "destination": "/use-cases/welcome"
    },
    {
      "source": "/v2/commerce-payments",
      "destination": "/api-features/commerce-payments"
    },
    {
      "source": "/v2/payee-destination",
      "destination": "/api-features/payee-destinations"
    },
    {
      "source": "/v2/payee-destination/signing-data",
      "destination": "/api-reference/v2payee-destination/get-eip-712-signing-data-with-nonce"
    },
    {
      "source": "/v2/payouts",
      "destination": "/api-features/payouts"
    },
    {
      "source": "/v2/payouts/batch",
      "destination": "/api-features/payouts"
    },
    {
      "source": "/webhooks",
      "destination": "/api-features/webhooks-events"
    }
  ],
  "navigation": {
    "tabs": [
      {
        "tab": "Use Cases",
        "groups": [
          {
            "group": "🚀 Get Started",
            "pages": [
              "use-cases/welcome",
              "use-cases/why-request-network",
              "use-cases/quickstart"
            ]
          },
          {
            "group": "🎯 Use Cases",
            "pages": [
              "use-cases/no-code-payment-links",
              "use-cases/programmatic-payment-links",
              "use-cases/multi-chain-checkout",
              "use-cases/batch-payouts",
              "use-cases/webhook-reconciliation",
              "use-cases/restrict-payer-wallets",
              {
                "group": "Compliance-gated payments",
                "pages": [
                  "use-cases/compliance-gated-payments",
                  "use-cases/hypernative-standard-screening-policy"
                ]
              }
            ]
          }
        ]
      },
      {
        "tab": "API",
        "groups": [
          {
            "group": "🔑 API Setup",
            "pages": [
              "api-setup/getting-started",
              "api-setup/integration-tutorial",
              "api-setup/llm-integration-guide",
              "api-features/client-id-management"
            ]
          },
          {
            "group": "⚙️ API Features",
            "pages": [
              {
                "group": "Requests",
                "pages": [
                  "api-features/create-requests"
                ]
              },
              {
                "group": "Payment Types",
                "pages": [
                  "api-features/payment-types-overview",
                  "api-features/standard-payments",
                  "api-features/conversion-payments",
                  "api-features/crypto-to-fiat-payments",
                  "api-features/batch-payments",
                  "api-features/crosschain-payments",
                  "api-features/partial-payments",
                  "api-features/recurring-payments"
                ]
              },
              {
                "group": "Reconciliation",
                "pages": [
                  "api-features/payment-detection",
                  "api-features/query-requests",
                  "api-features/query-payments",
                  "api-features/webhooks-events"
                ]
              },
              {
                "group": "Payee Destinations",
                "pages": [
                  "api-features/payee-destinations"
                ]
              },
              {
                "group": "Secure Payment Pages",
                "pages": [
                  "api-features/secure-payment-pages",
                  "api-features/secure-payment-integration-guide",
                  "api-features/safe-multisig-payments",
                  "api-features/secure-payment-supported-networks-and-currencies"
                ]
              },
              {
                "group": "Payouts",
                "pages": [
                  "api-features/payouts"
                ]
              },
              {
                "group": "Fee Structure",
                "pages": [
                  "api-features/platform-fees",
                  "api-features/protocol-fees",
                  "api-features/fee-breakdowns"
                ]
              },
              {
                "group": "Advanced",
                "pages": [
                  "api-features/commerce-payments"
                ]
              },
              {
                "group": "Orchestrators",
                "pages": [
                  "orchestrators/overview",
                  "orchestrators/fees",
                  "orchestrators/client-id-linking",
                  "orchestrators/kyt-plans",
                  "orchestrators/webhooks",
                  "orchestrators/whitelabel-branding"
                ]
              }
            ]
          },
          {
            "group": "📚 API Reference",
            "pages": [
              "api-reference/authentication",
              "api-reference/wallet-authentication",
              "api-reference/secure-payments",
              "api-reference/webhooks",
              {
                "group": "Endpoints (V2)",
                "openapi": "api-reference/openapi.v2.json",
                "pages": [
                  "api-reference/endpoints-overview"
                ]
              }
            ]
          }
        ]
      },
      {
        "tab": "Resources",
        "groups": [
          {
            "group": "🌐 Developer Resources",
            "pages": [
              "resources/supported-chains-and-currencies",
              "resources/token-list"
            ]
          },
          {
            "group": "🛠️ Tools",
            "pages": [
              "tools/dashboard",
              "tools/secure-payments"
            ]
          },
          {
            "group": "🏗️ Architecture",
            "pages": [
              "resources/lifecycle-of-a-request"
            ]
          },
          {
            "group": "📖 Documentation",
            "pages": [
              "faq",
              "glossary"
            ]
          },
          {
            "group": "📰 Release Notes",
            "pages": [
              "release-notes/index",
              "release-notes/request-api"
            ]
          }
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg",
    "href": "https://request.network"
  },
  "navbar": {
    "links": [
      {
        "label": "Support",
        "href": "https://github.com/orgs/RequestNetwork/discussions"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Open Dashboard",
      "href": "https://dashboard.request.network"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude",
      "perplexity",
      "mcp",
      "cursor",
      "vscode"
    ]
  },
  "seo": {
    "metatags": {
      "robots": "index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1",
      "og:locale": "en_US",
      "inLanguage": "en",
      "author": "Request Network",
      "article:publisher": "https://request.network"
    },
    "organization": {
      "id": "https://request.network/#organization",
      "name": "Request Network",
      "url": "https://request.network",
      "logo": "https://docs.request.network/logo/dark.svg",
      "sameAs": [
        "https://x.com/RequestNetwork",
        "https://request.network/discord",
        "https://github.com/RequestNetwork",
        "https://www.linkedin.com/company/request-network",
        "https://bsky.app/profile/requestnetwork.bsky.social",
        "https://request.network"
      ]
    }
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-F4XSSNMEN6"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/RequestNetwork",
      "discord": "https://request.network/discord",
      "github": "https://github.com/RequestNetwork",
      "linkedin": "https://www.linkedin.com/company/request-network",
      "bluesky": "https://bsky.app/profile/requestnetwork.bsky.social"
    },
    "links": [
      {
        "items": [
          {
            "label": "Website",
            "href": "https://request.network"
          },
          {
            "label": "Community",
            "href": "https://discord.com/invite/FsVAR3ny3f"
          },
          {
            "label": "Dashboard",
            "href": "https://dashboard.request.network"
          },
          {
            "label": "Pay",
            "href": "https://pay.request.network"
          },
          {
            "label": "Status",
            "href": "https://status.request.network"
          },
          {
            "label": "Blog",
            "href": "https://request.network/blog"
          }
        ]
      }
    ]
  }
}