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

# List Paylinks

> Retrieve all paylinks for the authenticated merchant



## OpenAPI

````yaml GET /paylinks
openapi: 3.0.3
info:
  title: OraFi Merchant API
  description: Seamless crypto payments API for merchants
  version: 1.0.0
  contact:
    name: OraFi Support
    email: support@orafi.app
servers:
  - url: https://api.orafi.app/v1
    description: Production server
  - url: http://localhost:3000/v1
    description: Local development server
security: []
tags:
  - name: Paylinks
    description: Paylink management endpoints
  - name: Payments
    description: Payment creation and verification endpoints
  - name: Customers
    description: Customer management endpoints
  - name: Transactions
    description: Transaction retrieval and payout endpoints
  - name: Refunds
    description: Refund management endpoints
  - name: Webhooks
    description: Webhook registration and management
  - name: Profile
    description: Business profile settings
  - name: Settlements
    description: Settlement account management
  - name: Fiat
    description: Fiat-related endpoints
  - name: Business
    description: Business mode and settings
  - name: Notifications
    description: Notification preferences
  - name: Subscriptions
    description: Subscription plans and customer subscriptions
paths:
  /paylinks:
    get:
      tags:
        - Paylinks
      summary: Get all paylinks
      description: Retrieve all paylinks for the authenticated merchant
      responses:
        '200':
          description: List of paylinks retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Paylinks retrieved successfully
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: '#/components/schemas/Paylink'
                        - type: object
                          properties:
                            images:
                              type: array
                              items:
                                $ref: '#/components/schemas/PaylinkImage'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKey: []
components:
  schemas:
    Paylink:
      type: object
      properties:
        id:
          description: Paylink unique identifier
          type: string
          example: paylink_abc123
        title:
          description: Paylink title
          type: string
          example: Product Payment
        description:
          description: Paylink description
          type: string
          example: Payment for awesome product
        amount:
          description: Payment amount
          type: number
          example: 100
        currency:
          description: Currency code
          type: string
          example: USDC
        imageBlobIds:
          description: Array of image blob IDs
          type: array
          items:
            type: string
        mode:
          description: Business mode
          type: string
          example: live
          enum:
            - test
            - live
        profileId:
          description: Associated business profile ID
          type: string
          example: profile_123
        createdAt:
          description: Creation timestamp
          type: string
          format: date-time
        updatedAt:
          description: Last update timestamp
          type: string
          format: date-time
    PaylinkImage:
      description: Image metadata associated with a paylink
      type: object
  responses:
    Unauthorized:
      description: Unauthorized - Missing or invalid API key
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Unauthorized access
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for merchant authentication required for most endpoints

````