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

# List Payees

> Retrieve all payees associated with a specific user, ordered by most recently added.



## OpenAPI

````yaml POST /api/platform/payee/list-payee/{user_id}
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: http://localhost:8001
  - url: https://api.pw.wintpay.com
  - url: https://test.pw.wintpay.com
  - url: https://api.sandbox.paywint.com
security: []
paths:
  /api/platform/payee/list-payee/{user_id}:
    post:
      tags:
        - Payee
      summary: List Payees
      description: >-
        Retrieve all payees associated with a specific user, ordered by most
        recently added.
      operationId: list_contact_api_platform_payee_list_payee__user_id__post
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Unique identifier (UUID) of the user.
            title: User Id
          description: Unique identifier (UUID) of the user.
          example: f47ac10b-****-****-****-0e02b2c3d479
        - name: X-Platform-ID
          in: header
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique platform identifier (UUID). You receive this during
              onboarding. Must be sent with every API request.
            title: X-Platform-Id
          description: >-
            Unique platform identifier (UUID). You receive this during
            onboarding. Must be sent with every API request.
        - name: X-Signature
          in: header
          required: true
          schema:
            type: string
            description: >-
              HMAC-SHA256 request signature for authentication. Use your
              platform secret key to compute it as: `METHOD + PATH + QUERY +
              BODY_HASH`.
            title: X-Signature
          description: >-
            HMAC-SHA256 request signature for authentication. Use your platform
            secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalPaginationRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ExternalListResponse_ExternalContactsRead_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExternalPaginationRequest:
      properties:
        rows_per_page:
          $ref: '#/components/schemas/RowsPerPage'
          description: >-
            Number of records to return per page. Accepted values are 10, 20,
            50, or 100.
          example: 50
        page_no:
          type: integer
          minimum: 1
          title: Page No
          description: >-
            Page number to retrieve, starting from 1. For example, page_no=1
            returns the first page of results.
          example: 1
      type: object
      required:
        - rows_per_page
        - page_no
      title: ExternalPaginationRequest
    ExternalListResponse_ExternalContactsRead_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        status_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Status Code
          description: HTTP status code representing the result of the request.
          default: 200
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: Short, human-readable message describing the outcome of the request.
          default: Success
        records:
          anyOf:
            - items:
                $ref: '#/components/schemas/ExternalContactsRead'
              type: array
            - type: 'null'
          title: Records
          description: List of result items returned for the current page.
        totalRecords:
          anyOf:
            - type: integer
            - type: 'null'
          title: Totalrecords
          description: >-
            Total number of matching records in the database, useful for
            paginating the full dataset.
          default: 0
        queryGeneratedTime:
          anyOf:
            - type: integer
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            Unix timestamp (in seconds) indicating when this response was
            generated.
          default: 1782303609
      type: object
      title: ExternalListResponse[ExternalContactsRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RowsPerPage:
      type: integer
      enum:
        - 10
        - 20
        - 50
        - 100
      title: RowsPerPage
    ExternalContactsRead:
      properties:
        payee_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Payee Id
          description: Unique identifier (UUID) assigned to the payee.
          example: f47ac10b-****-****-****-0e02b2c3d479
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Full name of the payee saved by the user.
          example: John Doe
        email:
          anyOf:
            - type: string
              format: email
            - type: 'null'
          title: Email
          description: Email address of the payee
          example: john.doe@example.com
        phone_country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone Country Code
          description: >-
            International dialing code of the payee’s phone number (e.g., +1 for
            US).
          example: '+1'
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
          description: Payee’s local phone number, excluding country code.
          example: '1234567890'
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Timestamp indicating when the payee was added to the contact list.
          example: '2025-06-10T18:10:42.000Z'
      type: object
      title: ExternalContactsRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````