Get a payment link
curl --request GET \
--url https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}', 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://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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"
"net/http"
"io"
)
func main() {
url := "https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"type": "PRODUCT_BASED",
"status": "ACTIVE",
"archived": true,
"version": 123,
"title": "<string>",
"description": "<string>",
"amount": 123,
"currency": "<string>",
"currentUsage": 123,
"maxUsage": 123,
"calculateTaxes": true,
"requestShippingAddress": true,
"requestPhoneNumber": true,
"allowPromotionCodes": true,
"callToActionMessage": "<string>",
"onSuccessAction": "<string>",
"redirectUrl": "<string>",
"customConfirmationMessage": "<string>",
"allowedTerms": [
12
],
"billingPeriod": "<string>",
"subscriptionDurationType": "<string>",
"fixedBillingCycles": 123,
"trialPeriodValue": 123,
"trialPeriodUnit": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"fields": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"type": "TEXT",
"isOptional": true,
"sequence": 123
}
],
"products": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "ACTIVE",
"price": 123,
"currency": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
]
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}Payment links
Get a payment link
A single link with its current fields and products. Archived links are returned too.
GET
/
developer
/
v1
/
payment-link
/
{id}
Get a payment link
curl --request GET \
--url https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}', 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://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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"
"net/http"
"io"
)
func main() {
url := "https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo-api-harmony.compago.com/api/developer/v1/payment-link/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"type": "PRODUCT_BASED",
"status": "ACTIVE",
"archived": true,
"version": 123,
"title": "<string>",
"description": "<string>",
"amount": 123,
"currency": "<string>",
"currentUsage": 123,
"maxUsage": 123,
"calculateTaxes": true,
"requestShippingAddress": true,
"requestPhoneNumber": true,
"allowPromotionCodes": true,
"callToActionMessage": "<string>",
"onSuccessAction": "<string>",
"redirectUrl": "<string>",
"customConfirmationMessage": "<string>",
"allowedTerms": [
12
],
"billingPeriod": "<string>",
"subscriptionDurationType": "<string>",
"fixedBillingCycles": 123,
"trialPeriodValue": 123,
"trialPeriodUnit": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"fields": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"type": "TEXT",
"isOptional": true,
"sequence": 123
}
],
"products": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "ACTIVE",
"price": 123,
"currency": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
]
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}Authorizations
Path Parameters
Response
Success.
The checkout URL to send the customer to.
Available options:
PRODUCT_BASED, FIXED_AMOUNT, SUBSCRIPTION, FLEXIBLE_AMOUNT Available options:
ACTIVE, INACTIVE Revision counter, bumped by every edit.
Null on product-based links, where the total comes from the products.
The installment plans the checkout offers, as numbers of monthly installments (1 is a single payment). null offers every plan active on your account. Always null on SUBSCRIPTION links, which are charged in a single payment every cycle.
Example:
[12]
Subscription links only.
Subscription links only.
Subscription links only.
Subscription links only.
Subscription links only.
Show child attributes
Show child attributes
Show child attributes
Show child attributes