Create payment link

POST

public

create-payment-link-digital-product

Create payment link

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-payment-link-digital-product \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "productData": {
          "title": "<string>",
          "shortDescription": "<string>",
          "status": "Draft",
          "thumbnailUrl": "<string>"
        },
        "pricingPlan": {
          "planType": "OneTimePaymentPlan",
          "config": {
            "friendlyPlanName": "<string>",
            "prices": [
              {
                "currencyType": "Aud",
                "currencySymbol": "<string>",
                "priceInLowestCurrencyUnit": 1
              }
            ],
            "inrCurrencySpecificData": {
              "isAmountExclusiveOfGst": true
            },
            "defaultFallbackCurrency": "Aud",
            "additionalDataToCollectOnCheckout": {
              "customFields": [
                {
                  "fieldType": "string",
                  "label": "<string>",
                  "sublabel": "<string>",
                  "isRequired": false
                }
              ]
            }
          }
        }
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "fermionDigitalProductId": "<string>",
        "paymentLinkUrl": "<string>"
      }
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.productData

object

required

Payment link information

Show child attributes

data.data.productData.title

string

required

Name of the payment link

Minimum string length: 1

data.data.productData.shortDescription

string

required

Brief description of the payment link

Minimum string length: 1

data.data.productData.status

enum<string>

required

Initial status of the payment link

Available options:

Draft,

Active,

Unlisted

data.data.productData.thumbnailUrl

string<uri>

URL of the payment link thumbnail image (optional, will use default if not provided)

data.data.pricingPlan

Optional pricing plan configuration. If not provided, no pricing will be set up.

Show child attributes

data.data.pricingPlan.planType

enum<string>

required

Type of pricing plan

Available options:

OneTimePaymentPlan

data.data.pricingPlan.config

object

required

Pricing plan configuration

Show child attributes

data.data.pricingPlan.config.friendlyPlanName

string

required

data.data.pricingPlan.config.prices

object[]

required

Show child attributes

data.data.pricingPlan.config.prices.currencyType

enum<string>

required

Available options:

Aud,

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

data.data.pricingPlan.config.prices.currencySymbol

string

required

data.data.pricingPlan.config.prices.priceInLowestCurrencyUnit

number

required

Required range: x >= 0

data.data.pricingPlan.config.inrCurrencySpecificData

object

required

Show child attributes

data.data.pricingPlan.config.inrCurrencySpecificData.isAmountExclusiveOfGst

boolean

required

data.data.pricingPlan.config.defaultFallbackCurrency

enum<string>

required

Available options:

Aud,

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

data.data.pricingPlan.config.additionalDataToCollectOnCheckout

object

Show child attributes

data.data.pricingPlan.config.additionalDataToCollectOnCheckout.customFields

object[]

required

Option 1
Option 2

Show child attributes

data.data.pricingPlan.config.additionalDataToCollectOnCheckout.customFields.fieldType

enum<string>

required

Available options:

string

data.data.pricingPlan.config.additionalDataToCollectOnCheckout.customFields.label

string

required

data.data.pricingPlan.config.additionalDataToCollectOnCheckout.customFields.sublabel

string

required

data.data.pricingPlan.config.additionalDataToCollectOnCheckout.customFields.isRequired

boolean

default:false

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.fermionDigitalProductId

string

required

Unique identifier of the created payment link

output.data.paymentLinkUrl

string

required

The payment link URL that can be shared with customers

Delete digital product coupon Delete (mark as deleted) a coupon for a fermion digital product. Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 10 requests in a window of 1m.

⌘I

Create payment link

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-payment-link-digital-product \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "productData": {
          "title": "<string>",
          "shortDescription": "<string>",
          "status": "Draft",
          "thumbnailUrl": "<string>"
        },
        "pricingPlan": {
          "planType": "OneTimePaymentPlan",
          "config": {
            "friendlyPlanName": "<string>",
            "prices": [
              {
                "currencyType": "Aud",
                "currencySymbol": "<string>",
                "priceInLowestCurrencyUnit": 1
              }
            ],
            "inrCurrencySpecificData": {
              "isAmountExclusiveOfGst": true
            },
            "defaultFallbackCurrency": "Aud",
            "additionalDataToCollectOnCheckout": {
              "customFields": [
                {
                  "fieldType": "string",
                  "label": "<string>",
                  "sublabel": "<string>",
                  "isRequired": false
                }
              ]
            }
          }
        }
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "fermionDigitalProductId": "<string>",
        "paymentLinkUrl": "<string>"
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response