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

# Create a payment link

> Creates a hosted payment link (ADDON, INVOICE, or CUSTOM). Auth: legacy `api_…` key or dashboard session.



## OpenAPI

````yaml /openapi.yaml post /payment-links
openapi: 3.0.3
info:
  title: ArcenPay API
  description: >
    The ArcenPay REST API powers subscription billing, entitlements, usage
    metering,

    payment links, checkout sessions, and autonomous agent payments across EVM
    (BOT Chain,

    Base, Arc, Sepolia) and Stellar.


    Every endpoint that accepts an API key supports the `Authorization: Bearer
    <key>` header.

    Key prefixes: `sk_…` (secret), `rk_…` (restricted), `pk_…` (publishable,
    read-only),

    `api_…` (legacy). Company-scoped customer endpoints accept an embed access
    token

    (`arc_tok_…` or a signed JWT from `identify()`). See the Authentication page
    for the

    full endpoint auth matrix.


    Manage catalog, environments, invoices, webhooks, feature flags, and agent
    configuration

    from the *dashboard* — those are not part of the developer-facing API
    reference.
  version: 1.0.0
servers:
  - url: https://api.arcenpay.com/api/v1
    description: Production
  - url: http://localhost:3300/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Credentials
    description: >-
      API keys, secret/publishable/restricted credentials, and short-lived
      tokens.
  - name: Companies
    description: Customer organizations, identity synchronization, and feature overrides.
  - name: Users
    description: Customer end-users associated with company organizations.
  - name: Events
    description: Ingest customer usage events and identification signals.
  - name: Access control
    description: >-
      Real-time entitlement checks, feature flags, and metered credit
      consumption.
  - name: Subscriptions
    description: >-
      On-chain subscription activation, self-serve plan switching, proration,
      and cancellation.
  - name: Checkout sessions
    description: Hosted checkout session lifecycle and status lookup.
  - name: Payment links
    description: Crypto payment links and dynamic payment URLs.
  - name: Autonomous agents
    description: >-
      Agent permissions, budget checking, on-chain funding, and auto-topup
      dispatch.
  - name: Mandates
    description: Recurring billing authorizations and mandate lifecycle.
  - name: Coupons
    description: Discount code validation and proration quoting.
  - name: zkTLS proofs
    description: Zero-knowledge TLS proofs verification via Reclaim Protocol.
  - name: Public
    description: Unauthenticated payment link specifications and checkout sessions.
  - name: Escrow
    description: >-
      Autonomous commit-reveal escrow reservations, release settlement, and
      dispute handling.
  - name: Features
    description: Feature catalog definitions, feature types, and linked plan entitlements.
paths:
  /payment-links:
    post:
      tags:
        - Payment links
      summary: Create a payment link
      description: >-
        Creates a hosted payment link (ADDON, INVOICE, or CUSTOM). Auth: legacy
        `api_…` key or dashboard session.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - kind
                - name
                - recipientWallet
              properties:
                kind:
                  type: string
                  enum:
                    - ADDON
                    - INVOICE
                    - CUSTOM
                name:
                  type: string
                description:
                  type: string
                companyId:
                  type: string
                catalogAddOnId:
                  type: string
                invoiceId:
                  type: string
                amount:
                  type: number
                acceptedToken:
                  type: string
                  description: Token address or symbol (USDC, USDT).
                currency:
                  type: string
                  default: USDC
                chainId:
                  type: number
                recipientWallet:
                  type: string
                isAgentic:
                  type: boolean
                successUrl:
                  type: string
                cancelUrl:
                  type: string
                expiresAt:
                  type: string
                  format: date-time
                metadata:
                  type: object
                  additionalProperties: true
      responses:
        '201':
          description: Payment link created
          content:
            application/json:
              schema:
                type: object
                properties:
                  paymentLink:
                    $ref: '#/components/schemas/PaymentLink'
        '400':
          $ref: '#/components/responses/BadRequest'
      security:
        - bearerAuth: []
components:
  schemas:
    PaymentLink:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        kind:
          type: string
          enum:
            - ADDON
            - INVOICE
            - CUSTOM
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - ARCHIVED
        amount:
          type: string
        currency:
          type: string
        acceptedToken:
          type: string
        recipientWallet:
          type: string
        chainId:
          type: number
        checkoutUrl:
          type: string
        isAgentic:
          type: boolean
        agenticSpecUrl:
          type: string
          nullable: true
  responses:
    BadRequest:
      description: Malformed request body or missing parameters.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              details:
                type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_… / rk_… / pk_… / api_…

````