Product
Create payment link
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.
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>",
"thumbnailUrl": "<string>"
},
"pricingPlan": {
"planType": "OneTimePaymentPlan",
"config": {
"friendlyPlanName": "<string>",
"prices": [
{
"currencySymbol": "<string>",
"priceInLowestCurrencyUnit": 1
}
],
"inrCurrencySpecificData": {
"isAmountExclusiveOfGst": true
}
}
}
}
}
]
}
'import requests
url = "https://backend.codedamn.com/api/public/create-payment-link-digital-product"
payload = { "data": [{ "data": {
"productData": {
"title": "<string>",
"shortDescription": "<string>",
"thumbnailUrl": "<string>"
},
"pricingPlan": {
"planType": "OneTimePaymentPlan",
"config": {
"friendlyPlanName": "<string>",
"prices": [
{
"currencySymbol": "<string>",
"priceInLowestCurrencyUnit": 1
}
],
"inrCurrencySpecificData": { "isAmountExclusiveOfGst": True }
}
}
} }] }
headers = {
"FERMION-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'FERMION-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
data: {
productData: {title: '<string>', shortDescription: '<string>', thumbnailUrl: '<string>'},
pricingPlan: {
planType: 'OneTimePaymentPlan',
config: {
friendlyPlanName: '<string>',
prices: [{currencySymbol: '<string>', priceInLowestCurrencyUnit: 1}],
inrCurrencySpecificData: {isAmountExclusiveOfGst: true}
}
}
}
}
]
})
};
fetch('https://backend.codedamn.com/api/public/create-payment-link-digital-product', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://backend.codedamn.com/api/public/create-payment-link-digital-product",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'data' => [
'productData' => [
'title' => '<string>',
'shortDescription' => '<string>',
'thumbnailUrl' => '<string>'
],
'pricingPlan' => [
'planType' => 'OneTimePaymentPlan',
'config' => [
'friendlyPlanName' => '<string>',
'prices' => [
[
'currencySymbol' => '<string>',
'priceInLowestCurrencyUnit' => 1
]
],
'inrCurrencySpecificData' => [
'isAmountExclusiveOfGst' => true
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"FERMION-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backend.codedamn.com/api/public/create-payment-link-digital-product"
payload := strings.NewReader("{\n \"data\": [\n {\n \"data\": {\n \"productData\": {\n \"title\": \"<string>\",\n \"shortDescription\": \"<string>\",\n \"thumbnailUrl\": \"<string>\"\n },\n \"pricingPlan\": {\n \"planType\": \"OneTimePaymentPlan\",\n \"config\": {\n \"friendlyPlanName\": \"<string>\",\n \"prices\": [\n {\n \"currencySymbol\": \"<string>\",\n \"priceInLowestCurrencyUnit\": 1\n }\n ],\n \"inrCurrencySpecificData\": {\n \"isAmountExclusiveOfGst\": true\n }\n }\n }\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("FERMION-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backend.codedamn.com/api/public/create-payment-link-digital-product")
.header("FERMION-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"data\": {\n \"productData\": {\n \"title\": \"<string>\",\n \"shortDescription\": \"<string>\",\n \"thumbnailUrl\": \"<string>\"\n },\n \"pricingPlan\": {\n \"planType\": \"OneTimePaymentPlan\",\n \"config\": {\n \"friendlyPlanName\": \"<string>\",\n \"prices\": [\n {\n \"currencySymbol\": \"<string>\",\n \"priceInLowestCurrencyUnit\": 1\n }\n ],\n \"inrCurrencySpecificData\": {\n \"isAmountExclusiveOfGst\": true\n }\n }\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.codedamn.com/api/public/create-payment-link-digital-product")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["FERMION-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"data\": {\n \"productData\": {\n \"title\": \"<string>\",\n \"shortDescription\": \"<string>\",\n \"thumbnailUrl\": \"<string>\"\n },\n \"pricingPlan\": {\n \"planType\": \"OneTimePaymentPlan\",\n \"config\": {\n \"friendlyPlanName\": \"<string>\",\n \"prices\": [\n {\n \"currencySymbol\": \"<string>\",\n \"priceInLowestCurrencyUnit\": 1\n }\n ],\n \"inrCurrencySpecificData\": {\n \"isAmountExclusiveOfGst\": true\n }\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"output": {
"status": "ok",
"data": {
"fermionDigitalProductId": "<string>",
"paymentLinkUrl": "<string>"
}
}
}
]⌘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>",
"thumbnailUrl": "<string>"
},
"pricingPlan": {
"planType": "OneTimePaymentPlan",
"config": {
"friendlyPlanName": "<string>",
"prices": [
{
"currencySymbol": "<string>",
"priceInLowestCurrencyUnit": 1
}
],
"inrCurrencySpecificData": {
"isAmountExclusiveOfGst": true
}
}
}
}
}
]
}
'import requests
url = "https://backend.codedamn.com/api/public/create-payment-link-digital-product"
payload = { "data": [{ "data": {
"productData": {
"title": "<string>",
"shortDescription": "<string>",
"thumbnailUrl": "<string>"
},
"pricingPlan": {
"planType": "OneTimePaymentPlan",
"config": {
"friendlyPlanName": "<string>",
"prices": [
{
"currencySymbol": "<string>",
"priceInLowestCurrencyUnit": 1
}
],
"inrCurrencySpecificData": { "isAmountExclusiveOfGst": True }
}
}
} }] }
headers = {
"FERMION-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'FERMION-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
data: {
productData: {title: '<string>', shortDescription: '<string>', thumbnailUrl: '<string>'},
pricingPlan: {
planType: 'OneTimePaymentPlan',
config: {
friendlyPlanName: '<string>',
prices: [{currencySymbol: '<string>', priceInLowestCurrencyUnit: 1}],
inrCurrencySpecificData: {isAmountExclusiveOfGst: true}
}
}
}
}
]
})
};
fetch('https://backend.codedamn.com/api/public/create-payment-link-digital-product', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://backend.codedamn.com/api/public/create-payment-link-digital-product",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'data' => [
'productData' => [
'title' => '<string>',
'shortDescription' => '<string>',
'thumbnailUrl' => '<string>'
],
'pricingPlan' => [
'planType' => 'OneTimePaymentPlan',
'config' => [
'friendlyPlanName' => '<string>',
'prices' => [
[
'currencySymbol' => '<string>',
'priceInLowestCurrencyUnit' => 1
]
],
'inrCurrencySpecificData' => [
'isAmountExclusiveOfGst' => true
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"FERMION-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backend.codedamn.com/api/public/create-payment-link-digital-product"
payload := strings.NewReader("{\n \"data\": [\n {\n \"data\": {\n \"productData\": {\n \"title\": \"<string>\",\n \"shortDescription\": \"<string>\",\n \"thumbnailUrl\": \"<string>\"\n },\n \"pricingPlan\": {\n \"planType\": \"OneTimePaymentPlan\",\n \"config\": {\n \"friendlyPlanName\": \"<string>\",\n \"prices\": [\n {\n \"currencySymbol\": \"<string>\",\n \"priceInLowestCurrencyUnit\": 1\n }\n ],\n \"inrCurrencySpecificData\": {\n \"isAmountExclusiveOfGst\": true\n }\n }\n }\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("FERMION-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backend.codedamn.com/api/public/create-payment-link-digital-product")
.header("FERMION-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"data\": {\n \"productData\": {\n \"title\": \"<string>\",\n \"shortDescription\": \"<string>\",\n \"thumbnailUrl\": \"<string>\"\n },\n \"pricingPlan\": {\n \"planType\": \"OneTimePaymentPlan\",\n \"config\": {\n \"friendlyPlanName\": \"<string>\",\n \"prices\": [\n {\n \"currencySymbol\": \"<string>\",\n \"priceInLowestCurrencyUnit\": 1\n }\n ],\n \"inrCurrencySpecificData\": {\n \"isAmountExclusiveOfGst\": true\n }\n }\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.codedamn.com/api/public/create-payment-link-digital-product")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["FERMION-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"data\": {\n \"productData\": {\n \"title\": \"<string>\",\n \"shortDescription\": \"<string>\",\n \"thumbnailUrl\": \"<string>\"\n },\n \"pricingPlan\": {\n \"planType\": \"OneTimePaymentPlan\",\n \"config\": {\n \"friendlyPlanName\": \"<string>\",\n \"prices\": [\n {\n \"currencySymbol\": \"<string>\",\n \"priceInLowestCurrencyUnit\": 1\n }\n ],\n \"inrCurrencySpecificData\": {\n \"isAmountExclusiveOfGst\": true\n }\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"output": {
"status": "ok",
"data": {
"fermionDigitalProductId": "<string>",
"paymentLinkUrl": "<string>"
}
}
}
]