> ## 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)).

# Get a withdrawal

> One of your withdrawal requests, in the shape of a list item. An id that belongs to another account answers exactly as an id that does not exist: `404` `withdrawal_not_found`. Full behaviour: https://mart.ps/api/docs#money/withdrawal.



## OpenAPI

````yaml /openapi.json get /api/v1/withdrawals/{withdrawal_id}
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/withdrawals/{withdrawal_id}:
    get:
      tags:
        - Money
      summary: Get a withdrawal
      description: >-
        One of your withdrawal requests, in the shape of a list item. An id that
        belongs to another account answers exactly as an id that does not exist:
        `404` `withdrawal_not_found`. Full behaviour:
        https://mart.ps/api/docs#money/withdrawal.
      operationId: getWithdrawal
      parameters:
        - name: withdrawal_id
          in: path
          required: true
          description: >-
            The `withdrawal_id` a request or the list returned, exactly as
            returned. Anything else answers 404 `withdrawal_not_found`, the same
            answer as another account's id.
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,16}$
            example: NDE
      responses:
        '200':
          description: Your withdrawal request.
          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:
                          withdrawal:
                            $ref: '#/components/schemas/Withdrawal'
              example:
                status: success
                status_code: 200
                message: OK
                data:
                  withdrawal:
                    withdrawal_id: NDE
                    amount: 125
                    status: approved
                    iban: PS92PALS000000000400123456702
                    reject_reason: null
                    requested_at: '2026-11-01T08:30:00+00:00'
                    approved_at: '2026-11-02T09:00:00+00:00'
                    paid_at: null
                    method: bank
                    requested_amount: 125
                meta: null
                error: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/WithdrawalsDisabled'
        '404':
          $ref: '#/components/responses/WithdrawalNotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/WithdrawalUnavailable'
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
    Withdrawal:
      type: object
      required:
        - withdrawal_id
        - amount
        - status
        - iban
        - reject_reason
        - requested_at
        - approved_at
        - paid_at
        - method
        - requested_amount
      properties:
        withdrawal_id:
          type: string
          description: >-
            Opaque. Use it in `GET /withdrawals/{withdrawal_id}` and in the
            cancel path.
          example: NDE
        amount:
          type: number
          format: float
          description: >-
            What is paid: what you asked for, unless Mart paid a cash request at
            another amount at the office counter (then `requested_amount` keeps
            what you asked for).
          example: 125
        status:
          type: string
          enum:
            - requested
            - approved
            - paid
            - rejected
            - cancelled
          description: >-
            `requested` and `approved` are open: they hold their amount back
            from `available`. `paid` is final and shows in the ledger as a
            `payment`. `rejected` and `cancelled` release the amount.
        iban:
          type: string
          nullable: true
          description: >-
            The IBAN this request will be paid to, fixed when it was approved,
            so a later change of your payout method cannot redirect it. Null
            before approval, on a request that was never approved, and always
            for cash.
          example: PS92PALS000000000400123456702
        reject_reason:
          type: string
          nullable: true
          description: Why Mart rejected it, in one line. Null for any other status.
          example: null
        requested_at:
          type: string
          format: date-time
          example: '2026-11-01T08:30:00+00:00'
        approved_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-11-02T09:00:00+00:00'
        paid_at:
          type: string
          format: date-time
          nullable: true
          example: null
        method:
          type: string
          enum:
            - bank
            - cash
          description: >-
            How this request is paid, fixed when you made it: `bank` (approved,
            then transferred) or `cash` (collected at the office: it goes from
            `requested` straight to `paid`, and `approved_at` stays null).
          example: bank
        requested_amount:
          type: number
          format: float
          description: >-
            What you asked for. The same as `amount`, unless the office paid a
            cash request at another amount.
          example: 125
    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'
    WithdrawalsDisabled:
      description: >-
        Withdrawals are not enabled for your account (`withdrawals_disabled`),
        cash at the office is not offered to your account (`cash_not_allowed`),
        the key does not have the scope this endpoint needs
        (`insufficient_scope`), or the key's customer is missing, inactive or
        outside the allowed groups (`api_customer_not_configured`,
        `customer_group_not_allowed`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    WithdrawalNotFound:
      description: >-
        No such withdrawal on your account (`withdrawal_not_found`). An id that
        belongs to another account, an id that never existed and a string this
        API never issued all answer exactly the same.
      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'
    WithdrawalUnavailable:
      description: >-
        The ledger cannot be answered right now (`ledger_unavailable`, no
        `Retry-After`), or, on a request, this account is being changed by
        another call (`withdrawal_busy`, with `Retry-After` in seconds: retry
        with the same `idempotency_key`). Nothing is created by a `503`, but a
        request that timed out may have been: retry with the same key and read
        the answer.
      headers:
        X-Mart-Environment:
          $ref: '#/components/headers/X-Mart-Environment'
      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.