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

# List supported payout methods

> Retrieve the catalog of payout methods/providers the store can configure. Requires the READ_PAYOUTS scope.

Returns the supported payout methods/providers available 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/supported
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/supported:
    get:
      tags:
        - Payouts
      summary: List supported payout methods
      description: >-
        Returns the catalog of payout methods/providers the store can configure,
        filtered to the store's currency. Payouts are read-only for apps; this
        is reference data and configuring a payout method is owner-only and 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: listSupportedPayouts
      responses:
        '200':
          description: Supported payout methods/providers.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/SupportedPayout'
              example:
                status: 200
                success: true
                message: Supported payouts retrieved
                data:
                  - _id: 66a9b8c7d6e5f4a3b2c1d0e9
                    id: bank_transfer_paystack
                    name: Bank Transfer via Paystack
                    description: Withdraw to your bank account
                    active: true
                    platform: paystack
                    channel: transfer
                    currencies:
                      - NGN
                    image: https://cdn.salesive.com/payouts/paystack.png
        '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.
    SupportedPayout:
      type: object
      description: A payout method/provider the store can configure.
      properties:
        _id:
          type: string
        id:
          type: string
          description: Stable method identifier (for example `bank_transfer_paystack`).
        name:
          type: string
          description: Display name of the method.
        description:
          type:
            - string
            - 'null'
        active:
          type: boolean
        platform:
          type: string
          description: >-
            Underlying payout provider (for example `paystack` or
            `flutterwave`).
        channel:
          type: string
          description: Payout channel (for example `transfer`).
        currencies:
          type: array
          description: Currency codes the method supports.
          items:
            type: string
        image:
          type:
            - string
            - 'null'
          description: Logo URL.
    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.

````