---
title: "Create payment link"
method: POST
path: "/public/create-payment-link-digital-product"
tags: ["Product"]
---

# Create payment link

`POST /public/create-payment-link-digital-product`

Create a new payment link for your school

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

## Request body

- object
  - `data` object[], required
    - `data` object, required
      - `productData` object, required — Payment link information
        - `title` string, required — Name of the payment link
        - `shortDescription` string, required — Brief description of the payment link
        - `thumbnailUrl` string, uri — URL of the payment link thumbnail image (optional, will use default if not provided)
        - `status` 'Draft' | 'Active' | 'Unlisted', required — Initial status of the payment link
      - `pricingPlan` union — Optional pricing plan configuration. If not provided, no pricing will be set up.
        - object
          - `planType` 'OneTimePaymentPlan', required — Type of pricing plan
          - `config` object, required — Pricing plan configuration
            - `friendlyPlanName` string, required
            - `prices` object[], required
              - …
            - `inrCurrencySpecificData` union, required
              - …
            - `defaultFallbackCurrency` 'Aud' | 'Aed' | 'Bdt' | 'Brl' | 'Cad' | 'Cop' | 'Dop' | 'Etb' | 'Eur' | 'Gbp' | 'Idr' | 'Inr' | 'Kes' | 'Lkr' | 'Mad' | 'Myr' | 'Mxn' | 'Ngn' | 'Npr' | 'Nzd' | 'Pkr' | 'Pln' | 'Rub' | 'Thb' | 'Try' | 'Usd' | 'Sgd' | 'Cny' | 'Sar' | 'Twd' | 'Jpy' | 'Krw' | 'Vnd', required
            - `additionalDataToCollectOnCheckout` object
              - …
        - unknown
        - unknown

## Response `200`

API Response Body

- object[]
  - `output` union, required
    - object
      - `status` 'ok', required
      - `data` object, required
        - `fermionDigitalProductId` string, required — Unique identifier of the created payment link
        - `paymentLinkUrl` string, required — The payment link URL that can be shared with customers
    - object
      - `status` 'error', required
      - `errorMessage` string, required

---

[API](https://skmtc.net/fermion/apis/fermion-backend-api.md) · [All operations](https://skmtc.net/fermion/apis/fermion-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fermion/fermion-backend-api/revisions/7ce364c8820b/schema)