{
  "opencollection": "1.0.0",
  "info": {
    "name": "Runa Payouts API",
    "version": "2024-02-05"
  },
  "items": [
    {
      "info": {
        "name": "Orders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.runa.io/v2/order",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of orders per page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a paginated list of orders created with the authenticated API key. Supports filtering and pagination."
        },
        {
          "info": {
            "name": "Create An Order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.runa.io/v2/order",
            "headers": [
              {
                "name": "X-Idempotency-Key",
                "value": ""
              },
              {
                "name": "X-Execution-Mode",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Create a new digital reward order. Specify the payment method, distribution method, and product selection. Use X-Execution-Mode header set to 'sync' for synchronous fulfillment or 'async' for asynchronous processing. Include X-Idempotency-Key to prevent duplicate orders on retry."
        },
        {
          "info": {
            "name": "Get Order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.runa.io/v2/order/:orderId",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "The unique order identifier"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve the details of a specific order by its ID. Use this endpoint to poll for order completion when using asynchronous mode."
        },
        {
          "info": {
            "name": "Estimate Order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.runa.io/v2/order/estimate",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Estimate the cost of an order before creating it. Returns the estimated face value, fees, and total cost in the account currency. Useful for presenting pricing to end users before checkout."
        }
      ]
    },
    {
      "info": {
        "name": "Products",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Products",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.runa.io/v2/products",
            "params": [
              {
                "name": "country",
                "value": "US",
                "type": "query",
                "description": "ISO 3166-1 alpha-2 country code to filter products"
              },
              {
                "name": "category",
                "value": "Retail",
                "type": "query",
                "description": "Category name to filter products"
              },
              {
                "name": "currency",
                "value": "USD",
                "type": "query",
                "description": "ISO 4217 currency code to filter products"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Search query to filter products by name"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Products per page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a paginated list of available gift card and payout products from the Runa catalog. Filter by country, category, currency, or search by name. Products represent individual brands available for digital reward distribution."
        },
        {
          "info": {
            "name": "Get Product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.runa.io/v2/products/:productId",
            "params": [
              {
                "name": "productId",
                "value": "",
                "type": "path",
                "description": "The unique product identifier"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve detailed information about a specific product including denomination options, supported countries, currencies, and redemption instructions."
        },
        {
          "info": {
            "name": "List Product Categories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.runa.io/v2/products/categories",
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve the list of product categories available in the Runa catalog. Use category names to filter products when browsing or building product selection UIs."
        },
        {
          "info": {
            "name": "List Supported Countries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.runa.io/v2/products/countries",
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve the list of countries supported by the Runa platform. Use country codes to filter the product catalog to brands available in specific markets."
        }
      ]
    },
    {
      "info": {
        "name": "Balance",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Account Balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.runa.io/v2/balance",
            "params": [
              {
                "name": "currency",
                "value": "USD",
                "type": "query",
                "description": "ISO 4217 currency code (e.g., USD, GBP, EUR)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve the current account balance. If the currency query parameter is provided, returns a single balance object. If omitted, returns balances for all currencies with a positive balance."
        }
      ]
    },
    {
      "info": {
        "name": "Utilities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Ping",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.runa.io/v2/ping",
            "auth": {
              "type": "apikey",
              "key": "X-Api-Key",
              "value": "{{X-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Health check endpoint to verify API connectivity and authentication. Returns a simple success response when the API key is valid."
        }
      ]
    }
  ],
  "bundled": true
}