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

# Retrieve a payment link

> One payment link, with how many payments it has taken.

Requires the `payment_links:read` scope.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/payment-links/{linkId}
openapi: 3.1.0
info:
  title: Talescria API
  version: 1.0.0
  description: >-
    Accounts, recipients, payments, transfers between your accounts, payment
    links, customers and invoices. Authenticate with an access token from your
    OAuth client.
servers:
  - url: https://api.talescria.com
    description: Production (test and live keys)
security:
  - bearerAuth: []
tags:
  - name: Accounts
    description: Your accounts and their balances.
  - name: Recipients
    description: People and businesses you pay, and where to pay them.
  - name: Payments
    description: Paying recipients, including across currencies.
  - name: Transfers
    description: Moving money between your own accounts.
  - name: Payment links
    description: Links anyone can open to pay you by card.
  - name: Customers
    description: People and businesses who pay you.
  - name: Invoices
    description: One-off invoices and recurring series.
paths:
  /v1/payment-links/{linkId}:
    get:
      tags:
        - Payment links
      summary: Retrieve a payment link
      description: |-
        One payment link, with how many payments it has taken.

        Requires the `payment_links:read` scope.
      operationId: retrieveAPaymentLink
      parameters:
        - name: linkId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The link.
          content:
            application/json:
              schema:
                type: object
                properties:
                  paymentLink:
                    $ref: '#/components/schemas/PaymentLink'
        '401':
          description: >-
            `UNAUTHENTICATED`: The access token is missing, expired or revoked.
            Get a new token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            `INSUFFICIENT_SCOPE`: Your API key lacks the scope this operation
            needs. The scope is named in `message` and the `WWW-Authenticate`
            header.


            `ENVIRONMENT_MISMATCH`: The request named a different environment
            from the key's.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            `NOT_FOUND`: It doesn't exist, or isn't yours. The answer is the
            same for both.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`RATE_LIMITED`: Too many requests. Wait for `Retry-After` seconds.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: '`UPSTREAM_UNAVAILABLE`: Temporarily unavailable. Retry with backoff.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    PaymentLink:
      type: object
      required:
        - id
        - url
        - amount
        - usage
        - status
        - paymentsCompleted
        - paymentInProgress
        - createdAt
      properties:
        id:
          type: string
        url:
          type: string
          description: What the payer opens.
        amount:
          $ref: '#/components/schemas/Money'
        country:
          type: string
        description:
          type:
            - string
            - 'null'
        usage:
          type: string
          enum:
            - single
            - reusable
        status:
          type: string
          enum:
            - active
            - expired
            - completed
            - archived
          description: >-
            `completed`: a single-use link that has been paid. `expired` is
            derived from `expiresAt`.
        expiresAt:
          type:
            - integer
            - 'null'
        accountId:
          type:
            - string
            - 'null'
          description: The receiving account (GET /v1/accounts ids).
        customer:
          description: Who it was made for; null for nobody in particular.
          oneOf:
            - type: 'null'
            - type: object
              required:
                - id
                - name
                - email
                - deleted
              properties:
                id:
                  type: string
                name:
                  type: string
                email:
                  type: string
                deleted:
                  type: boolean
                  description: Deleted since. The link still says who it was for.
        paymentsCompleted:
          type: integer
        lastPaidAt:
          type:
            - integer
            - 'null'
        paymentInProgress:
          type: boolean
          description: A single-use link someone is paying right now.
        createdAt:
          type: integer
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Branch on this, not on `message`. See Errors.
            message:
              type: string
              description: For people. Wording can change.
    Money:
      type: object
      required:
        - minorUnits
        - currency
      properties:
        minorUnits:
          type: string
          pattern: ^-?\d+$
          description: Integer minor units as a string. Never a float.
          example: '125000'
        currency:
          type: string
          example: USD
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token (`at_test_…` or `at_live_…`) from `POST
        https://idp.talescria.com/oauth/token`.

````

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