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

# Get a payment link

> Public: no API key needed.

Public: no API key needed.


## OpenAPI

````yaml GET /payments/links/{linkId}
openapi: 3.1.0
info:
  title: Paywire API
  version: 1.0.0
  description: >-
    Accept crypto payments: create payment links, follow orders, receive signed
    webhooks.
servers:
  - url: https://api.staging.paywire.xyz
    description: Staging (testnets)
security:
  - apiKey: []
tags:
  - name: Payment links
  - name: Orders
  - name: Account
  - name: Webhooks
paths:
  /payments/links/{linkId}:
    get:
      tags:
        - Payment links
      summary: Get a payment link
      description: 'Public: no API key needed.'
      operationId: getPaymentLink
      parameters:
        - name: linkId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The payment link's id.
      responses:
        '200':
          description: The payment link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLink'
              example:
                id: 0193a0c4-5f2e-7c1d-9b8a-3e4f5a6b7c8d
                merchantId: 0193a0b1-2c3d-7e4f-8a9b-0c1d2e3f4a5b
                amount: 49.9
                currency: USD
                allowedAssets:
                  - network: ethereum_sepolia
                    token: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238'
                    decimals: 6
                  - network: solana_devnet
                    token: native
                    decimals: 9
                callbackUrl: https://shop.example.com/webhooks/paywire
                orderTtlMinutes: 20
                policyOverride: null
                returnUrl: https://shop.example.com/orders/1042
                isActive: true
                createdAt: '2026-10-24T09:12:31.204Z'
        '404':
          description: No such link.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: PaymentLink.NotFound
                status: 404
                detail: No payment link with this id.
      security: []
components:
  schemas:
    PaymentLink:
      type: object
      properties:
        id:
          type: string
          format: uuid
        merchantId:
          type: string
          format: uuid
        amount:
          type: number
        currency:
          type: string
        allowedAssets:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
        callbackUrl:
          type: string
          format: uri
        orderTtlMinutes:
          type: integer
        policyOverride:
          $ref: '#/components/schemas/PolicyOverride'
        returnUrl:
          type:
            - string
            - 'null'
          format: uri
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
    Problem:
      type: object
      description: RFC 7807 problem details. `title` is a stable error code.
      properties:
        type:
          type: string
        title:
          type: string
          example: PaymentLink.NotFound
        status:
          type: integer
        detail:
          type: string
    Asset:
      allOf:
        - $ref: '#/components/schemas/AssetRef'
        - type: object
          properties:
            decimals:
              type: integer
              example: 18
    PolicyOverride:
      type:
        - object
        - 'null'
      description: This link's own payment policy, replacing the company's.
      properties:
        tolerancePercent:
          type:
            - number
            - 'null'
          description: Shortfall or excess, in %, that still counts as exact.
        overpayDustThreshold:
          type:
            - number
            - 'null'
          description: Fiat excess kept rather than refunded.
        overpayReviewThreshold:
          type:
            - number
            - 'null'
          description: Fiat difference above which a person reviews.
    AssetRef:
      type: object
      required:
        - network
        - token
      properties:
        network:
          type: string
          example: ethereum_sepolia
          description: Network id. See Networks and assets.
        token:
          type: string
          example: native
          description: >-
            `native` for the network's coin, else the token contract (mint on
            Solana).
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Your gateway's API key (`w3g_...`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.