> ## 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 payout methods

> Retrieve the store's configured payout methods. Requires the READ_PAYOUTS scope.

Returns the store's configured payout methods with their method details; 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
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:
    get:
      tags:
        - Payouts
      summary: List payout methods
      description: >-
        Returns the store's configured payout methods. Each entry references a
        supported payout method and carries the merchant-supplied method details
        in `data` (for example bank account fields). Payouts are read-only for
        apps; configuring or removing a payout method and initiating withdrawals
        are owner-only and are 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: listPayouts
      responses:
        '200':
          description: The store's configured payout methods.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Payout'
              example:
                status: 200
                success: true
                message: Payouts retrieved
                data:
                  - _id: 66b1f0a3c2d4e5f6a7b8c9d0
                    user: 66a0c1d2e3f4a5b6c7d8e9f0
                    shop: 6680aabbccddeeff00112200
                    payout: 66a9b8c7d6e5f4a3b2c1d0e9
                    data:
                      accountNumber: '1234567890'
                      bankCode: '058'
                      accountName: Ada Lovelace
                      bankName: GTBank
                    createdAt: '2026-02-01T08:00:00.000Z'
                    updatedAt: '2026-02-01T08:00:00.000Z'
        '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.
    Payout:
      type: object
      description: >-
        A payout method configured by the store. `payout` references the
        supported payout method by id; `data` holds the merchant-supplied method
        details.
      properties:
        _id:
          type: string
        user:
          type: string
          description: Id of the user who configured the method.
        shop:
          type: string
          description: The store id (bound server-side).
        payout:
          type: string
          description: Referenced supported-payout method id.
        data:
          type: object
          additionalProperties: true
          description: Method-specific details (for example bank account fields).
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    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.

````