Create Payment Link
Generate a payment link for one-time or recurring payments
POST
/
api
/
v2
/
payment-links
Create Payment Link
curl --request POST \
--url https://api.example.com/api/v2/payment-linksimport requests
url = "https://api.example.com/api/v2/payment-links"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v2/payment-links', 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://api.example.com/api/v2/payment-links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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://api.example.com/api/v2/payment-links"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/payment-links")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/payment-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyCreate Payment Link
Generate a payment link that customers can use to complete checkout. Payment links automatically handle HSA/FSA eligibility detection and can be used for both one-time and recurring payments.All monetary amounts are integers in cents (e.g., 4995 = $49.95).
Authentication
Authorization: Bearer glm_test_YOUR_API_KEY
Request Body
{
"amount": 4995,
"currency": "USD",
"description": "Premium Blood Pressure Monitor",
"customer": {
"email": "customer@example.com",
"first_name": "Jane",
"last_name": "Doe"
},
"products": [
{
"merchant_product_id": "BP-MONITOR-001",
"name": "Blood Pressure Monitor",
"quantity": 1,
"price": 4995
}
],
"payment_type": "one_time",
"success_url": "https://yoursite.com/success",
"cancel_url": "https://yoursite.com/cancel",
"metadata": {
"order_id": "ORD-12345"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | integer | Yes | Total amount in cents |
currency | string | Yes | ISO 4217 currency code (e.g., "USD") |
description | string | Yes | Description of the payment |
customer | object | No | Pre-fill customer information |
customer.email | string | No | Customer email |
customer.first_name | string | No | Customer first name |
customer.last_name | string | No | Customer last name |
products | array | No | Product line items |
products[].merchant_product_id | string | Yes* | Your product reference ID |
products[].name | string | Yes* | Product name |
products[].quantity | integer | Yes* | Quantity |
products[].price | integer | Yes* | Unit price in cents |
payment_type | enum | No | one_time or subscription (default: one_time) |
subscription | object | No | Required if payment_type is subscription |
subscription.interval | enum | Yes* | daily, weekly, monthly, yearly |
subscription.interval_count | integer | No | Number of intervals (default: 1) |
subscription.trial_period_days | integer | No | Free trial days |
success_url | string | Yes | Redirect URL after successful payment |
cancel_url | string | No | Redirect URL if customer cancels |
metadata | object | No | Custom key-value pairs |
expires_at | timestamp | No | When link expires (default: 15 days) |
Response
{
"id": "plink_abc123xyz",
"url": "https://checkout.withgale.com/pay/plink_abc123xyz",
"amount": 4995,
"currency": "USD",
"description": "Premium Blood Pressure Monitor",
"payment_type": "one_time",
"status": "active",
"customer": {
"email": "customer@example.com",
"first_name": "Jane",
"last_name": "Doe"
},
"products": [
{
"merchant_product_id": "BP-MONITOR-001",
"name": "Blood Pressure Monitor",
"quantity": 1,
"price": 4995,
"hsa_fsa_eligible": true
}
],
"success_url": "https://yoursite.com/success",
"cancel_url": "https://yoursite.com/cancel",
"metadata": {
"order_id": "ORD-12345"
},
"expires_at": "2026-03-12T14:30:00Z",
"created_at": "2026-02-25T14:30:00Z"
}
Example
curl -X POST https://api.withgale.com/api/v2/payment-links \
-H "Authorization: Bearer glm_test_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"amount": 2995,
"currency": "USD",
"description": "Digital Thermometer",
"products": [
{
"merchant_product_id": "THERM-001",
"name": "Digital Thermometer",
"quantity": 1,
"price": 2995
}
],
"success_url": "https://yoursite.com/success"
}'
Subscription Intervals
| Interval | interval_count | Billing Frequency |
|---|---|---|
monthly | 1 | Every month |
monthly | 3 | Every 3 months (quarterly) |
weekly | 1 | Every week |
weekly | 2 | Every 2 weeks (bi-weekly) |
yearly | 1 | Every year |
Payment Link Status
| Status | Description |
|---|---|
active | Link is active and ready for payment |
expired | Link has expired (past expires_at time) |
paid | Payment completed successfully |
cancelled | Link was cancelled |
Webhooks
When a customer completes payment on a payment link, Gale sends webhook events to your registered endpoints:order.completed— Payment captured successfullyorder.failed— Payment failed or declined
Errors
| Status Code | Error Code | Description |
|---|---|---|
| 400 | invalid_request | Missing or invalid parameters |
| 400 | invalid_amount | Amount must be positive integer in cents |
| 401 | unauthorized | Invalid or missing API key |
| 422 | validation_error | Field validation failed |
Related
⌘I
Create Payment Link
curl --request POST \
--url https://api.example.com/api/v2/payment-linksimport requests
url = "https://api.example.com/api/v2/payment-links"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v2/payment-links', 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://api.example.com/api/v2/payment-links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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://api.example.com/api/v2/payment-links"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/payment-links")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/payment-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body