toc.json

{
  "items": [
    {
      "type": "item",
      "title": "Welcome to the Settle API Docs!",
      "uri": "docs/a.welcome.md"
    },
    {
      "type": "divider",
      "title": "Introduction"
    },
    {
      "type": "item",
      "title": "Interacting with the Settle API",
      "uri": "docs/1. Introduction/a.interacting-with-the-settle-api.md"
    },
    {
      "type": "item",
      "title": "API Authentication",
      "uri": "docs/1. Introduction/b.api-authentication.md"
    },
    {
      "type": "item",
      "title": "Callbacks",
      "uri": "docs/1. Introduction/c.callbacks.md"
    },
    {
      "type": "item",
      "title": "Verifying signatures from Settle",
      "uri": "docs/1. Introduction/d.verifying-signatures-from-settle.md"
    },
    {
      "type": "item",
      "title": "Attachments",
      "uri": "docs/1. Introduction/e.attachments.md"
    },
    {
      "type": "item",
      "title": "Permission Request",
      "uri": "docs/1. Introduction/e.permission-requests.md"
    },
    {
      "type": "item",
      "title": "Ledgers",
      "uri": "docs/1. Introduction/f.ledgers.md"
    },
    {
      "type": "item",
      "title": "Settlements",
      "uri": "docs/1. Introduction/g.settlement.md"
    },
    {
      "type": "item",
      "title": "ShortLinks",
      "uri": "docs/1. Introduction/h.shortlinks.md"
    },
    {
      "type": "item",
      "title": "Developer Support",
      "uri": "docs/1. Introduction/i.developer-support.md"
    },
    {
      "type": "divider",
      "title": "Guides"
    },
    {
      "type": "group",
      "title": "Getting Started",
      "items": [
        {
          "type": "item",
          "title": "The Sandbox environment",
          "uri": "docs/2. Guides/Getting Started/01-the-sandbox-environment.md"
        },
        {
          "type": "item",
          "title": "Set up a business account",
          "uri": "docs/2. Guides/Getting Started/02-set-up-a-business-account.md"
        },
        {
          "type": "item",
          "title": "Install and use Postman for testing the Settle API",
          "uri": "docs/2. Guides/Getting Started/03-test-the-settle-api-with-postman.md"
        },
        {
          "type": "item",
          "title": "Getting ready for Production",
          "uri": "docs/2. Guides/Getting Started/04-get-ready-for-production.md"
        }
      ]
    },
    {
      "type": "group",
      "title": "Payments",
      "items": [
        {
          "type": "item",
          "title": "Request, Capture and Refund Payments",
          "uri": "docs/2. Guides/Payments/request-capture-refund.md"
        }
      ]
    },
    {
      "type": "item",
      "title": "Verifying Callback Signatures with Node.js",
      "uri": "docs/2. Guides/verifying-callback-signatures-with-node.md"
    },
    {
      "type": "divider",
      "title": "Developer Tools"
    },
    {
      "type": "item",
      "title": "Settle CLI",
      "uri": "docs/4. Developer Tools/01-settle-cli.md"
    },
    {
      "type": "item",
      "title": "Libraries and UI Components",
      "uri": "docs/4. Developer Tools/02-libraries-and-ui-components.md"
    },
    {
      "type": "item",
      "title": "Sample Integrations",
      "uri": "docs/4. Developer Tools/03-sample-integrations.md"
    },
    {
      "type": "item",
      "title": "Reference Docs",
      "uri": "docs/4. Developer Tools/04-reference-docs.md"
    },
    {
      "type": "item",
      "title": "Testing Checklist",
      "uri": "docs/4. Developer Tools/05-testing-checklist.md"
    },
    {
      "type": "item",
      "title": "Error Codes",
      "uri": "docs/4. Developer Tools/06-error-codes.md"
    },
    {
      "type": "item",
      "title": "Status Codes",
      "uri": "docs/4. Developer Tools/08-status-codes.md"
    },
    {
      "type": "divider",
      "title": "Use Cases"
    },
    {
      "type": "item",
      "title": "Introduction",
      "uri": "docs/5. Use Cases/0-introduction.md"
    },
    {
      "type": "group",
      "title": "Online Payments",
      "items": [
        {
          "type": "item",
          "title": "Settle at Checkout",
          "uri": "docs/5. Use Cases/1. Online Payments/01-settle-at-checkout.md"
        },
        {
          "type": "item",
          "title": "Buy Now with Settle",
          "uri": "docs/5. Use Cases/1. Online Payments/02-buy-now-with-settle.md"
        },
        {
          "type": "item",
          "title": "Recurring Payments",
          "uri": "docs/5. Use Cases/1. Online Payments/03-recurring-payments.md"
        }
      ]
    },
    {
      "type": "group",
      "title": "In-Store Payments",
      "items": [
        {
          "type": "item",
          "title": "Settle at Checkout",
          "uri": "docs/5. Use Cases/2. In-Store Payments/settle-at-checkout.md"
        }
      ]
    },
    {
      "type": "group",
      "title": "In-App Payments",
      "items": [
        {
          "type": "item",
          "title": "Settle with a Button",
          "uri": "docs/5. Use Cases/3. In-App Payments/settle-with-a-button.md"
        }
      ]
    },
    {
      "type": "group",
      "title": "Custom Solutions",
      "items": [
        {
          "type": "item",
          "title": "Bars & Restaurants",
          "uri": "docs/5. Use Cases/4. Custom Solutions/bars-and-restaurants.md"
        },
        {
          "type": "item",
          "title": "Gyms",
          "uri": "docs/5. Use Cases/4. Custom Solutions/gyms.md"
        },
        {
          "type": "item",
          "title": "Parking",
          "uri": "docs/5. Use Cases/4. Custom Solutions/parking.md"
        },
        {
          "type": "item",
          "title": "Takeout & Delivery",
          "uri": "docs/5. Use Cases/4. Custom Solutions/takeout-and-delivery.md"
        },
        {
          "type": "item",
          "title": "Ticketing",
          "uri": "docs/5. Use Cases/4. Custom Solutions/ticketing.md"
        },
        {
          "type": "item",
          "title": "Vending Machines",
          "uri": "docs/5. Use Cases/4. Custom Solutions/vending-machines.md"
        }
      ]
    },
    {
      "type": "divider",
      "title": "Value-Added Services"
    },
    {
      "type": "item",
      "title": "Introduction",
      "uri": "docs/6. Value-Added Services/00-introduction.md"
    },
    {
      "type": "item",
      "title": "Data Sharing (Permission Requests)",
      "uri": "docs/6. Value-Added Services/01-data-sharing.md"
    },
    {
      "type": "item",
      "title": "Login with Settle",
      "uri": "docs/6. Value-Added Services/02-login-with-settle.md"
    },
    {
      "type": "divider",
      "title": "Reference Documentation"
    },
    {
      "type": "item",
      "title": "Introduction",
      "uri": "reference/a.introduction.md"
    },
    {
      "type": "group",
      "title": "SDK's",
      "items": [
        {
          "type": "group",
          "title": "Settle SDK for Node.js",
          "items": [
            {
              "type": "item",
              "title": "Inroduction",
              "uri": "docs/7. Reference Documentation/SDK's/Settle SDK for Node.js/a.introduction.md"
            },
            {
              "type": "item",
              "title": "Client Functions",
              "uri": "docs/7. Reference Documentation/SDK's/Settle SDK for Node.js/client-functions.md"
            }
          ]
        },
        {
          "type": "group",
          "title": "Settle SDK for PHP",
          "items": [
            {
              "type": "item",
              "title": "Introduction",
              "uri": "docs/7. Reference Documentation/SDK's/Settle SDK for PHP/a.introduction.md"
            }
          ]
        }
      ]
    },
    {
      "type": "group",
      "title": "API's",
      "items": [
        {
          "type": "item",
          "title": "Merchant API",
          "uri": "reference/merchant.v1.yaml"
        },
        {
          "type": "group",
          "title": "Models",
          "items": [
            {
              "type": "item",
              "title": "AccessTokenResponse",
              "uri": "models/AccessTokenResponse.v1.yaml"
            },
            {
              "type": "item",
              "title": "Capture",
              "uri": "models/Capture.yaml"
            },
            {
              "type": "item",
              "title": "Currency",
              "uri": "models/Currency.v1.yaml"
            },
            {
              "type": "item",
              "title": "Cursor",
              "uri": "models/Cursor.yaml"
            },
            {
              "type": "item",
              "title": "Date",
              "uri": "models/Date.yaml"
            },
            {
              "type": "item",
              "title": "DateTime",
              "uri": "models/DateTime.yaml"
            },
            {
              "type": "item",
              "title": "Fee",
              "uri": "models/Fee.yaml"
            },
            {
              "type": "item",
              "title": "IdentityDocumentation",
              "uri": "models/IdentityDocumentation.yaml"
            },
            {
              "type": "item",
              "title": "Item",
              "uri": "models/Item.yaml"
            },
            {
              "type": "item",
              "title": "JSON",
              "uri": "models/JSON.v1.yaml"
            },
            {
              "type": "item",
              "title": "LineItem",
              "uri": "models/LineItem.v1.yaml"
            },
            {
              "type": "item",
              "title": "LineItemMetadata",
              "uri": "models/LineItemMetadata.v1.yaml"
            },
            {
              "type": "item",
              "title": "Location.yaml",
              "uri": "models/Location.yaml"
            },
            {
              "type": "item",
              "title": "MerchantProfileRegistration",
              "uri": "models/MerchantProfileRegistration.yaml"
            },
            {
              "type": "item",
              "title": "Money",
              "uri": "models/Money.v1.yaml"
            },
            {
              "type": "item",
              "title": "MoneyInteger",
              "uri": "models/MoneyInteger.v1.yaml"
            },
            {
              "type": "item",
              "title": "Name",
              "uri": "models/Name.yaml"
            },
            {
              "type": "item",
              "title": "NameResponse",
              "uri": "models/NameResponse.yaml"
            },
            {
              "type": "item",
              "title": "NdbKey",
              "uri": "models/NdbKey.yaml"
            },
            {
              "type": "item",
              "title": "NullableBoolean",
              "uri": "models/NullableBoolean.yaml"
            },
            {
              "type": "item",
              "title": "PaymentRequestLink",
              "uri": "models/PaymentRequestLink.v1.yaml"
            },
            {
              "type": "item",
              "title": "PaymentRequestListItem",
              "uri": "models/PaymentRequestListItem.yaml"
            },
            {
              "type": "item",
              "title": "PayoutDetail",
              "uri": "models/PayoutDetail.yaml"
            },
            {
              "type": "item",
              "title": "PersonIdentifier",
              "uri": "models/PersonIdentifier.v1.yaml"
            },
            {
              "type": "item",
              "title": "Product",
              "uri": "models/Product.yaml"
            },
            {
              "type": "item",
              "title": "ProductSalesTable",
              "uri": "models/ProductSalesTable.yaml"
            },
            {
              "type": "item",
              "title": "ProductSalesTableEntry",
              "uri": "models/ProductSalesTableEntry.yaml"
            },
            {
              "type": "item",
              "title": "PubKey",
              "uri": "models/PubKey.yaml"
            },
            {
              "type": "item",
              "title": "QuantitySum",
              "uri": "models/QuantitySum.yaml"
            },
            {
              "type": "item",
              "title": "ReceiptItems",
              "uri": "models/ReceiptItems.yaml"
            },
            {
              "type": "item",
              "title": "ReceiptPayments",
              "uri": "models/ReceiptPayments.yaml"
            },
            {
              "type": "item",
              "title": "Refund",
              "uri": "models/Refund.yaml"
            },
            {
              "type": "item",
              "title": "ReportSummary",
              "uri": "models/ReportSummary.yaml"
            },
            {
              "type": "item",
              "title": "RunningSum",
              "uri": "models/RunningSum.yaml"
            },
            {
              "type": "item",
              "title": "SalesSummaryProduct",
              "uri": "models/SalesSummaryProduct.yaml"
            },
            {
              "type": "item",
              "title": "Scope",
              "uri": "models/Scope.v1.yaml"
            },
            {
              "type": "item",
              "title": "Select",
              "uri": "models/Select.yaml"
            },
            {
              "type": "item",
              "title": "SelectMultiple",
              "uri": "models/SelectMultiple.yaml"
            },
            {
              "type": "item",
              "title": "SettlementAccountFrequency",
              "uri": "models/SettlementAccountFrequency.yaml"
            },
            {
              "type": "item",
              "title": "SettlementListItem",
              "uri": "models/SettlementListItem.yaml"
            },
            {
              "type": "item",
              "title": "SettlementListReportContext",
              "uri": "models/SettlementListReportContext.yaml"
            },
            {
              "type": "item",
              "title": "SettlementListSummary",
              "uri": "models/SettlementListSummary.yaml"
            },
            {
              "type": "item",
              "title": "SettlementPayout",
              "uri": "models/SettlementPayout.yaml"
            },
            {
              "type": "item",
              "title": "ShippingAdddress",
              "uri": "models/ShippingAddress.yaml"
            },
            {
              "type": "item",
              "title": "Store",
              "uri": "models/Store.yaml"
            },
            {
              "type": "item",
              "title": "Sum",
              "uri": "models/Sum.yaml"
            },
            {
              "type": "item",
              "title": "Time",
              "uri": "models/Time.yaml"
            },
            {
              "type": "item",
              "title": "TimeDelta",
              "uri": "models/TimeDelta.yaml"
            },
            {
              "type": "item",
              "title": "UserInfo",
              "uri": "models/UserInfo.yaml"
            },
            {
              "type": "item",
              "title": "VatSalesTable",
              "uri": "models/VatSalesTable.yaml"
            },
            {
              "type": "item",
              "title": "VatSalesTableEntry",
              "uri": "models/VatSalesTableEntry.yaml"
            }
          ]
        }
      ]
    }
  ]
}