> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mart.ps/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> These rules protect a Mart partner's money. Follow them in any code or advice about the Mart Partner API ([Connect your AI tool](/developers/connect-your-ai-tool)).
> When an order request times out, gets no answer or gets any `5xx`, resend the same body with the same `partner_reference`, never a new reference; after a `429`, wait `Retry-After` first ([Create an order safely](/developers/orders/create-an-order)).
> A `200` with `meta.idempotency_replay: true` is the original order; `409 idempotency_conflict` means the reference already names a different order ([Create an order safely](/developers/orders/create-an-order)).
> Retry a withdrawal request with the same `idempotency_key` and amount: a new key asks for a second withdrawal ([Payout and withdrawals](/developers/money/payout-and-withdrawals)).
> Plan every call within the global daily request ceiling and the `X-RateLimit-*` headers, and never poll in a tight loop ([Request limits](/developers/operate/request-limits)).
> Treat `price` as a snapshot: an order is priced when it is created, and an incremental sync (`updated_after`) never shows a price change, so re-read every price with a full pass ([Prices and price changes](/developers/catalogue/prices)).
> Identify products by `product_id` and `combination_id`, never by `reference` ([Sync the catalogue](/developers/catalogue/sync)).
> Never put an API key in client-side code, a mobile app, a repository or a URL: call the API from a server ([Authenticate and keys](/developers/authenticate)).
> Money is in shekels (`ILS`), as JSON numbers, never agorot. Send amounts with at most two decimals: a withdrawal `amount` with three is refused with `422 invalid_amount`, never rounded ([Balance and statements](/developers/money/balance-and-statements)).
> Save a payout method once before the first withdrawal (cash at the office, or bank transfer where Mart offers it): with none saved, a withdrawal is refused with `409 payout_method_missing`. Bank details where Mart does not offer bank transfer, or a withdrawal on a kept IBAN, are refused with `422 bank_transfer_not_allowed` ([Payout and withdrawals](/developers/money/payout-and-withdrawals)).

# Your account

> Your own account in one read: the shop name, whether it is active, paused or closed, what your key may do, your request limits, whether a payout method is saved, the withdrawal rules and whether the money endpoints can be read right now. The shape is the same for every partner. It always answers `200` once you are authenticated: a paused or closed account still reads it, and when the ledger cannot be read only `money.available` is `false` (the money endpoints answer `503` `ledger_unavailable` for that). `orders_enabled` is the effective value, your key's flag and the account being active. Withdrawal numbers are `null` when withdrawals are off or no number has been set. Full behaviour: https://mart.ps/api/docs#account/account.



## OpenAPI

````yaml /openapi.json get /api/v1/account
openapi: 3.0.3
info:
  title: Mart Partner API
  version: 1.1.0
  description: >-
    REST API for Mart reseller partners: the product catalog (with per-product
    and per-combination stock), delivery destinations, and order creation — cash
    on delivery or card.


    Every response, success or failure, uses the envelope `{status, status_code,
    message, data, meta, error}`; branch on `error.code`, never on `message`.
    Response keys are structurally stable: absent objects are `null`, absent
    collections are `[]`; the only caller-controlled structural variance is the
    products listing's `include=` parameter.


    Authenticate with `Authorization: Bearer <key>` (preferred) or `X-Api-Key`.
    A key holds scopes, each operation names the one it needs in
    `x-required-scope`, and a key without it is answered `403`
    `insufficient_scope` (`details.required_scope` names it) without using any
    quota; keys made before scopes existed keep exactly the access they had.
    Rate limits are per key on fixed minute/day windows; the `X-RateLimit-*`
    headers are authoritative.


    **Environments** — build against the sandbox first.
    `https://sandbox.mart.ps` is a separate installation with its own keys
    (`mk_test_…`), a periodically refreshed copy of the catalog, synthetic
    customers and orders, and Lahza's test gateway: nothing placed there is
    fulfilled or charged, and its data is reset on a published schedule.
    Production keys are `mk_live_…` and work only against `https://mart.ps`; a
    key sent to the wrong environment answers `401` `key_environment_mismatch`
    before anything else is checked. Every response carries `X-Mart-Environment:
    production|sandbox` — assert it in your client so a misconfigured base URL
    fails loudly.


    This document is the machine contract. The human documentation — onboarding,
    sync guidance, pricing semantics, idempotent retries, the full error
    catalogue with remedies — is at https://mart.ps/api/docs.
servers:
  - url: https://mart.ps
    description: Production
  - url: https://sandbox.mart.ps
    description: Sandbox
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Products
    description: 'Catalog: listing and product detail, with prices and stock.'
  - name: Categories
    description: Catalog category vocabulary for the products category_id filter.
  - name: Attributes
    description: Attribute-group vocabulary behind the products combination attributes.
  - name: Delivery
    description: Delivery destinations for order shipping addresses.
  - name: Orders
    description: >-
      Cash-on-delivery order creation, order list, dry-run validation, order
      read and cancellation.
  - name: Money
    description: >-
      Your balance, the ledger of movements, your statements, your payout
      method, your withdrawals and the feed of events on your account.
  - name: Reports
    description: Your own order totals by month, and your most ordered products.
  - name: Account
    description: 'Your own account: its state, limits and withdrawal rules.'
paths:
  /api/v1/account:
    get:
      tags:
        - Account
      summary: Your account
      description: >-
        Your own account in one read: the shop name, whether it is active,
        paused or closed, what your key may do, your request limits, whether a
        payout method is saved, the withdrawal rules and whether the money
        endpoints can be read right now. The shape is the same for every
        partner. It always answers `200` once you are authenticated: a paused or
        closed account still reads it, and when the ledger cannot be read only
        `money.available` is `false` (the money endpoints answer `503`
        `ledger_unavailable` for that). `orders_enabled` is the effective value,
        your key's flag and the account being active. Withdrawal numbers are
        `null` when withdrawals are off or no number has been set. Full
        behaviour: https://mart.ps/api/docs#account/account.
      operationId: getAccount
      responses:
        '200':
          description: Your account.
          headers:
            X-Mart-Environment:
              $ref: '#/components/headers/X-Mart-Environment'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          account:
                            $ref: '#/components/schemas/Account'
              example:
                status: success
                status_code: 200
                message: OK
                data:
                  account:
                    shop_display_name: Al Noor Shop
                    status: active
                    orders_enabled: true
                    card_enabled: false
                    price_override_allowed: true
                    free_shipping_allowed: false
                    rate_limits:
                      per_minute: 120
                      per_day: 20000
                    payout_method_saved: false
                    withdrawals:
                      enabled: false
                      minimum: null
                      max_open_requests: null
                    money:
                      available: true
                meta: null
                error: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenGroup'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      x-codeSamples:
        - lang: bash
          label: cURL recipe
          source: >
            #!/usr/bin/env bash

            # Make your first call: read your own account.

            # Needs MART_API_BASE (https://sandbox.mart.ps while you build,
            https://mart.ps live) and MART_API_KEY.

            set -euo pipefail


            # The key goes to curl through a file descriptor, so it never shows
            in the process list.

            response=$(curl --silent --show-error --max-time 30 \
              --header @<(printf 'Authorization: Bearer %s\n' "$MART_API_KEY") \
              --write-out '\n%{http_code} %header{x-mart-environment} %header{retry-after}' \
              "$MART_API_BASE/api/v1/account") || { echo "error: no answer" >&2; exit 1; }
            body=${response%$'\n'*}

            read -r status environment retry_after <<<"${response##*$'\n'}"


            if [ "$status" != 200 ]; then
              echo "error: $status $(jq -r '.error.code' <<<"$body" 2>/dev/null || echo '(not JSON)')${retry_after:+, try again after $retry_after s}" >&2
              exit 1
            fi


            # Every answer names the installation that served it: check it
            before anything else.

            echo "environment: $environment"

            jq -r '.data.account | "account status: \(.status)\norders enabled:
            \(.orders_enabled)"' <<<"$body"
        - lang: typescript
          label: TypeScript recipe
          source: >
            // Make your first call: read your own account. Node 22.18 or later
            runs this .ts file as it is.

            // Needs MART_API_BASE (https://sandbox.mart.ps while you build,
            https://mart.ps live) and MART_API_KEY.

            const base = process.env.MART_API_BASE;

            const key = process.env.MART_API_KEY;

            if (!base || !key) throw new Error('Set MART_API_BASE and
            MART_API_KEY');


            const response = await fetch(`${base}/api/v1/account`, {
              headers: { Authorization: `Bearer ${key}` },
              signal: AbortSignal.timeout(30_000),
            });

            const body = await response.json().catch(() => null); // an edge
            error page is not JSON

            if (!response.ok || body === null) {
              const retryAfter = response.headers.get('retry-after');
              console.error(`error: ${response.status} ${body?.error?.code ?? '(not JSON)'}${retryAfter ? `, try again after ${retryAfter} s` : ''}`);
              process.exit(1);
            }


            // Every answer names the installation that served it: check it
            before anything else.

            console.log(`environment:
            ${response.headers.get('x-mart-environment')}`);

            console.log(`account status: ${body.data.account.status}`);

            console.log(`orders enabled: ${body.data.account.orders_enabled}`);
        - lang: python
          label: Python recipe
          source: >
            """Make your first call: read your own account. Python 3.9 or later,
            with httpx.


            Needs MART_API_BASE (https://sandbox.mart.ps while you build,
            https://mart.ps live) and MART_API_KEY.

            """

            import os

            import sys


            import httpx


            base = os.environ["MART_API_BASE"]

            key = os.environ["MART_API_KEY"]


            response = httpx.get(f"{base}/api/v1/account",
            headers={"Authorization": f"Bearer {key}"}, timeout=30)

            try:
                body = response.json()
            except ValueError:  # an edge error page is not JSON
                body = None
            if response.is_error or body is None:
                retry_after = response.headers.get("Retry-After")
                sys.exit(f"error: {response.status_code} {body['error']['code'] if body else '(not JSON)'}"
                         + (f", try again after {retry_after} s" if retry_after else ""))

            # Every answer names the installation that served it: check it
            before anything else.

            print(f"environment: {response.headers['X-Mart-Environment']}")

            account = body["data"]["account"]

            print(f"account status: {account['status']}")

            print(f"orders enabled: {str(account['orders_enabled']).lower()}")
        - lang: php
          label: PHP recipe
          source: >
            <?php

            // Make your first call: read your own account. PHP 7.4 or later,
            with the curl extension.

            // Needs MART_API_BASE (https://sandbox.mart.ps while you build,
            https://mart.ps live) and MART_API_KEY.

            $base = getenv('MART_API_BASE');

            $key = getenv('MART_API_KEY');


            /**
             * One request with the curl extension. Returns [status, headers (lower-case name => value), body];
             * status 0 when there was no answer at all.
             */
            function request(string $method, string $url, string $key, ?string
            $payload = null, int $timeout = 30): array

            {
                $headers = [];
                $curl = curl_init($url);
                curl_setopt_array($curl, [
                    CURLOPT_CUSTOMREQUEST => $method,
                    CURLOPT_HTTPHEADER => ["Authorization: Bearer $key", 'Content-Type: application/json'],
                    CURLOPT_RETURNTRANSFER => true,
                    CURLOPT_CONNECTTIMEOUT => 10,
                    CURLOPT_TIMEOUT => $timeout,
                    CURLOPT_HEADERFUNCTION => function ($curl, string $line) use (&$headers): int {
                        $parts = explode(':', $line, 2);
                        if (count($parts) === 2) {
                            $headers[strtolower(trim($parts[0]))] = trim($parts[1]);
                        }
                        return strlen($line);
                    },
                ]);
                if ($payload !== null) {
                    curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
                }
                $body = curl_exec($curl);
                $status = $body === false ? 0 : (int) curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
                curl_close($curl);

                return [$status, $headers, (string) $body];
            }


            /** ", try again after N s" when the answer says how long to wait
            (Retry-After), else nothing. */

            function when(array $headers): string

            {
                return isset($headers['retry-after']) ? ", try again after {$headers['retry-after']} s" : '';
            }


            [$status, $headers, $raw] = request('GET', "$base/api/v1/account",
            $key);

            $body = json_decode($raw, true); // null for an answer that is not
            JSON (an edge error page)

            if ($status !== 200 || !is_array($body)) {
                fwrite(STDERR, 'error: ' . ($status === 0 ? 'no answer' : $status . ' ' . ($body['error']['code'] ?? '(not JSON)')) . when($headers) . "\n");
                exit(1);
            }


            // Every answer names the installation that served it: check it
            before anything else.

            echo "environment: {$headers['x-mart-environment']}\n";

            $account = $body['data']['account'];

            echo "account status: {$account['status']}\n";

            echo 'orders enabled: ' . ($account['orders_enabled'] ? 'true' :
            'false') . "\n";
        - lang: go
          label: Go recipe
          source: "//go:build ignore\n\n// Make your first call: read your own account. Go 1.22 or later, standard library only.\n// Needs MART_API_BASE (https://sandbox.mart.ps while you build, https://mart.ps live) and MART_API_KEY.\n// Run it with: go run first-call.go\npackage main\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"os\"\n\t\"time\"\n)\n\nvar client = &http.Client{Timeout: 30 * time.Second}\n\nfunc main() {\n\treq, err := http.NewRequest(http.MethodGet, os.Getenv(\"MART_API_BASE\")+\"/api/v1/account\", nil)\n\tif err != nil {\n\t\tfail(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer \"+os.Getenv(\"MART_API_KEY\"))\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tfail(fmt.Errorf(\"no answer: %v\", err))\n\t}\n\tenvironment := resp.Header.Get(\"X-Mart-Environment\")\n\n\tvar body struct {\n\t\tData struct {\n\t\t\tAccount struct {\n\t\t\t\tStatus        string `json:\"status\"`\n\t\t\t\tOrdersEnabled bool   `json:\"orders_enabled\"`\n\t\t\t} `json:\"account\"`\n\t\t} `json:\"data\"`\n\t}\n\tdecode(resp, &body)\n\n\t// Every answer names the installation that served it: check it before anything else.\n\tfmt.Println(\"environment:\", environment)\n\tfmt.Println(\"account status:\", body.Data.Account.Status)\n\tfmt.Println(\"orders enabled:\", body.Data.Account.OrdersEnabled)\n}\n\n// decode reads an answer into out. An error answer, or one that is not JSON (an edge error page),\n// stops with its status and error code.\nfunc decode(resp *http.Response, out any) {\n\tdefer resp.Body.Close()\n\traw, err := io.ReadAll(resp.Body)\n\tif err != nil {\n\t\tfail(err)\n\t}\n\tvar envelope struct {\n\t\tError *struct {\n\t\t\tCode string `json:\"code\"`\n\t\t} `json:\"error\"`\n\t}\n\tif resp.StatusCode >= 300 {\n\t\tcode := \"(not JSON)\"\n\t\tif json.Unmarshal(raw, &envelope) == nil && envelope.Error != nil {\n\t\t\tcode = envelope.Error.Code\n\t\t}\n\t\twait := \"\"\n\t\tif after := resp.Header.Get(\"Retry-After\"); after != \"\" {\n\t\t\twait = \", try again after \" + after + \" s\"\n\t\t}\n\t\tfail(fmt.Errorf(\"%d %s%s\", resp.StatusCode, code, wait))\n\t}\n\tif err := json.Unmarshal(raw, out); err != nil {\n\t\tfail(fmt.Errorf(\"%d (not JSON)\", resp.StatusCode))\n\t}\n}\n\nfunc fail(err error) {\n\tfmt.Fprintln(os.Stderr, \"error:\", err)\n\tos.Exit(1)\n}\n"
        - lang: java
          label: Java recipe
          source: >
            // Make your first call: read your own account. Java 17 or later,
            with Jackson (jackson-databind).

            // Needs MART_API_BASE (https://sandbox.mart.ps while you build,
            https://mart.ps live) and MART_API_KEY.

            // Run it as a single file: java -cp <the Jackson jars>
            first-call.java

            import com.fasterxml.jackson.databind.JsonNode;

            import com.fasterxml.jackson.databind.ObjectMapper;

            import java.io.IOException;

            import java.net.URI;

            import java.net.http.HttpClient;

            import java.net.http.HttpRequest;

            import java.net.http.HttpResponse;

            import java.time.Duration;

            import java.util.Locale;


            class FirstCall {
                static final HttpClient CLIENT = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(10)).build();
                static final ObjectMapper JSON = new ObjectMapper();

                public static void main(String[] args) throws Exception {
                    HttpRequest request = HttpRequest.newBuilder(URI.create(System.getenv("MART_API_BASE") + "/api/v1/account"))
                            .header("Authorization", "Bearer " + System.getenv("MART_API_KEY"))
                            .timeout(Duration.ofSeconds(30))
                            .GET()
                            .build();
                    HttpResponse<String> response = CLIENT.send(request, HttpResponse.BodyHandlers.ofString());
                    JsonNode body = parse(response.body());
                    if (response.statusCode() >= 300 || body == null) {
                        fail(response.statusCode() + " " + code(body) + when(response));
                    }

                    // Every answer names the installation that served it: check it before anything else.
                    System.out.println("environment: " + response.headers().firstValue("X-Mart-Environment").orElse(""));
                    JsonNode account = body.path("data").path("account");
                    System.out.println("account status: " + account.path("status").asText());
                    System.out.println("orders enabled: " + account.path("orders_enabled").asBoolean());
                }

                /** The JSON body, or null for an answer that is not JSON (an edge error page). */
                static JsonNode parse(String text) {
                    try {
                        return JSON.readTree(text);
                    } catch (IOException e) {
                        return null;
                    }
                }

                static void fail(String message) {
                    System.err.println("error: " + message);
                    System.exit(1);
                }

                static String code(JsonNode body) {
                    return body == null ? "(not JSON)" : body.path("error").path("code").asText();
                }

                /** ", try again after N s" when the answer says how long to wait (Retry-After), else nothing. */
                static String when(HttpResponse<String> response) {
                    return response.headers().firstValue("Retry-After").map(s -> ", try again after " + s + " s").orElse("");
                }
            }
components:
  headers:
    X-Mart-Environment:
      description: >-
        Which installation answered: `production` or `sandbox`. Present on every
        response; assert it once at startup.
      schema:
        type: string
        enum:
          - production
          - sandbox
    X-RateLimit-Limit:
      description: Limit of the tightest active window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the tightest active window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Epoch seconds when the tightest window resets.
      schema:
        type: integer
  schemas:
    SuccessEnvelope:
      type: object
      required:
        - status
        - status_code
        - message
        - data
        - meta
        - error
      properties:
        status:
          type: string
          enum:
            - success
        status_code:
          type: integer
          example: 200
        message:
          type: string
          example: OK
        data:
          type: object
          description: >-
            One key named after the resource (products / product / states /
            categories / attributes / order / validation).
        meta:
          nullable: true
          type: object
        error:
          nullable: true
          type: object
          enum:
            - null
    Account:
      type: object
      required:
        - shop_display_name
        - status
        - orders_enabled
        - card_enabled
        - price_override_allowed
        - free_shipping_allowed
        - rate_limits
        - payout_method_saved
        - withdrawals
        - money
      properties:
        shop_display_name:
          type: string
          description: >-
            The name of your shop on Mart's records. When none was set, your
            first and last name.
          example: Al Noor Shop
        status:
          type: string
          enum:
            - active
            - paused
            - closed
          description: >-
            `paused` stops new orders only: `POST /orders` and `POST
            /orders/validate` answer `422` `orders_not_enabled`. Everything you
            read, and cancelling an order, keeps working. `closed` is final: no
            new orders, and your key keeps at most reading your money and asking
            for withdrawals.
          example: active
        orders_enabled:
          type: boolean
          description: >-
            Whether `POST /orders` will take an order now: your key is enabled
            for orders and the account is active.
          example: true
        card_enabled:
          type: boolean
          description: Whether your key may send card orders.
          example: false
        price_override_allowed:
          type: boolean
          description: Whether you may send your own selling price on an order line.
          example: true
        free_shipping_allowed:
          type: boolean
          description: Whether you may send `free_shipping` on a cash order.
          example: false
        rate_limits:
          type: object
          required:
            - per_minute
            - per_day
          description: >-
            Your key's request limits across the API. Some endpoints have a
            tighter limit of their own.
          properties:
            per_minute:
              type: integer
              example: 120
            per_day:
              type: integer
              example: 20000
        payout_method_saved:
          type: boolean
          description: Whether a payout method is saved on the account.
          example: false
        withdrawals:
          type: object
          required:
            - enabled
            - minimum
            - max_open_requests
          properties:
            enabled:
              type: boolean
              example: false
            minimum:
              type: number
              format: float
              nullable: true
              description: >-
                The smallest request, in ILS. `null` when withdrawals are off or
                no minimum is set.
              example: null
            max_open_requests:
              type: integer
              nullable: true
              description: >-
                How many requests may be open at once. `null` when withdrawals
                are off or no limit is set.
              example: null
        money:
          type: object
          required:
            - available
          properties:
            available:
              type: boolean
              description: >-
                Whether `/balance`, `/ledger` and `/statements` can be read
                right now. `false` is not an error here: those endpoints answer
                `503` `ledger_unavailable`.
              example: true
    ErrorEnvelope:
      type: object
      required:
        - status
        - status_code
        - message
        - data
        - meta
        - error
      properties:
        status:
          type: string
          enum:
            - fail
        status_code:
          type: integer
          example: 422
        message:
          type: string
        data:
          nullable: true
          enum:
            - null
        meta:
          nullable: true
          enum:
            - null
        error:
          type: object
          required:
            - code
            - details
          properties:
            code:
              type: string
              enum:
                - missing_api_key
                - invalid_api_key
                - key_environment_mismatch
                - api_customer_not_configured
                - customer_group_not_allowed
                - insufficient_scope
                - product_not_found
                - order_not_found
                - route_not_found
                - method_not_allowed
                - invalid_parameter
                - invalid_state
                - rate_limit_exceeded
                - bad_request
                - orders_not_enabled
                - api_group_misconfigured
                - idempotency_conflict
                - unknown_product
                - product_not_offered
                - product_not_orderable
                - combination_required
                - combination_not_allowed
                - unknown_combination
                - combination_mismatch
                - duplicate_product
                - cart_minimum_not_met
                - price_below_minimum
                - price_override_not_allowed
                - insufficient_stock
                - free_shipping_not_covered
                - free_shipping_not_allowed
                - card_not_enabled
                - internal_error
                - order_not_cancellable
                - order_cancellation_not_configured
                - order_cancellation_in_progress
                - card_not_on_file
                - saved_card_invalid
                - card_price_not_allowed
                - card_free_shipping_not_allowed
                - card_declined
                - payment_gateway_unavailable
                - order_creation_in_progress
                - charge_amount_mismatch
                - invalid_cursor
                - cursor_expired
                - ledger_unavailable
                - statement_not_found
                - withdrawals_disabled
                - invalid_iban
                - invalid_account_holder_name
                - invalid_national_id
                - invalid_amount
                - amount_below_minimum
                - payout_method_missing
                - withdrawals_locked
                - too_many_open_withdrawals
                - insufficient_available
                - withdrawal_busy
                - withdrawal_not_found
                - withdrawal_not_cancellable
                - cash_not_allowed
                - payout_method_change_blocked
                - amount_above_cash_maximum
                - invalid_payout_method
                - bank_transfer_not_allowed
            details:
              description: >-
                Structured context (parameter name, supported values, retry
                hints). Empty array when none.
  responses:
    Unauthorized:
      description: >-
        Missing or unusable API key (`missing_api_key`, `invalid_api_key`).
        Revoked and paused keys answer identically to unknown keys. A key issued
        for the other environment answers `key_environment_mismatch` before any
        lookup: `details.environment` names the environment you called
        (`production` or `sandbox`) — switch base URL or key. See the
        Environments note in the introduction.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ForbiddenGroup:
      description: >-
        The key customer is missing or inactive (`api_customer_not_configured`)
        or outside the allowed groups (`customer_group_not_allowed`). Group
        membership is re-checked on every request; access resumes when the
        customer rejoins an allowed group. This endpoint needs no scope that can
        be missing: a key without the order-writing permission is answered `422`
        `orders_not_enabled` by the endpoint itself.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    MethodNotAllowed:
      description: >-
        The method is not accepted on this endpoint (`method_not_allowed`). Read
        the `Allow` response header rather than assuming; `OPTIONS` is accepted
        everywhere and answered as a bodyless 204.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    UnprocessableEntity:
      description: >-
        Invalid parameter value (`invalid_parameter`); `error.details` names the
        parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: >-
        Rate limit exceeded (`rate_limit_exceeded`). Carries `Retry-After`
        (seconds) plus the X-RateLimit-* trio of the exceeded window; day-window
        breaches advertise the day reset, not a 60-second retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Opaque server failure (`internal_error`). Details are logged server-side
        and never exposed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer <key>'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.