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

# Get the payout fee

> Retrieve the fee charged on a payout for the store's currency. Requires the READ_PAYOUTS scope.

Returns the fee charged on a withdrawal for the store's currency; payouts are read-only for apps. The store is bound to your app token server-side — never send a shop id.


## OpenAPI

````yaml GET /payouts/fee
openapi: 3.1.0
info:
  title: Salesive Apps API — Account
  version: 1.0.0
  description: >-
    Read the store's account configuration — domains, staff roles and payout
    methods — and manage its identity verification (KYC) from an installed
    third-party app. Every endpoint authenticates with an installed-app access
    token (prefix `app_`) and requires a specific OAuth scope. The target store
    is bound to the token server-side from the installation — never send a shop
    id. Domains, roles and payouts are read-only for apps: their
    create/update/delete operations are owner-only and are not exposed here.
servers:
  - url: https://api.salesive.com/api/v1
    description: Production
security:
  - AppToken: []
paths:
  /payouts/fee:
    get:
      tags:
        - Payouts
      summary: Get the payout fee
      description: >-
        Returns the fee charged on a payout (withdrawal) for the store's
        currency. Payouts are read-only for apps; initiating a withdrawal is
        owner-only and is not exposed here. Requires the `READ_PAYOUTS` scope
        and returns 403 if the token is missing it. The store is bound to the
        app token server-side from the installation — never send a shop id.
      operationId: getPayoutFee
      parameters:
        - name: currency
          in: query
          required: false
          description: >-
            ISO 4217 currency code to get the fee for (for example `NGN`).
            Defaults to the store's currency.
          schema:
            type: string
      responses:
        '200':
          description: The payout fee.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/PayoutFee'
              example:
                status: 200
                success: true
                message: Payout fee retrieved
                data:
                  fee: 150
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    EnvelopeBase:
      type: object
      description: >-
        Standard Salesive response envelope. The operation-specific payload is
        carried in `data`.
      required:
        - status
        - success
        - message
      properties:
        status:
          type: integer
          description: HTTP status code, echoed in the body.
        success:
          type: boolean
          description: Whether the request succeeded.
        message:
          type: string
          description: Human-readable result message.
    PayoutFee:
      type: object
      description: The fee charged on a payout for the requested currency.
      properties:
        fee:
          type: number
          description: The payout fee amount.
    Envelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              description: Operation-specific payload (object, array, or null).
  responses:
    Unauthorized:
      description: Missing or invalid app access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 401
            success: false
            message: Authentication required
            data: null
    Forbidden:
      description: The app token is missing the OAuth scope required for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 403
            success: false
            message: Insufficient scope
            data: null
  securitySchemes:
    AppToken:
      type: http
      scheme: bearer
      description: >-
        Installed-app access token (prefix app_), issued by the OAuth install
        flow. The store is bound to the token server-side — never send a shop
        id.

````