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

# Retrieve Paylink

> Retrieve details of a specific paylink



## OpenAPI

````yaml GET /paylinks/{paylinkId}
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/{paylinkId}:
    get:
      tags:
        - Paylinks
      summary: Get paylink details
      description: Retrieve details of a specific paylink
      parameters:
        - name: paylinkId
          in: path
          description: The paylink ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Paylink details retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Paylink retrieved successfully
                  data:
                    allOf:
                      - $ref: '#/components/schemas/Paylink'
                      - type: object
                        properties:
                          images:
                            type: array
                            items:
                              $ref: '#/components/schemas/PaylinkImage'
                          profile:
                            $ref: '#/components/schemas/BusinessProfile'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
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
    BusinessProfile:
      type: object
      properties:
        id:
          description: Business profile unique identifier
          type: string
          example: profile_abc123
        businessName:
          description: Business name
          type: string
          example: Acme Corp
        businessSector:
          description: Business sector/industry
          type: string
          example: E-commerce
        country:
          description: Country of operation
          type: string
          example: NG
        websiteLink:
          description: Business website URL
          type: string
          format: uri
        email:
          description: Business email
          type: string
          format: email
        isLive:
          description: Whether account is in live mode
          type: boolean
          example: true
        createdAt:
          description: Creation timestamp
          type: string
          format: date-time
  responses:
    BadRequest:
      description: Bad request - Invalid input or validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Validation error message
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Resource not found

````