Skip to main content
GET
/
v2
/
payment-links
/
{id}
Get Payment Link
curl --request GET \
  --url https://api.example.com/v2/payment-links/{id}

Get Payment Link

Retrieve information about a payment link, including its current status and payment details.

Authentication

Authorization: Bearer glm_test_YOUR_API_KEY

Path Parameters

ParameterTypeRequiredDescription
idstringYesPayment link ID (e.g., plink_abc123xyz)

Response

All monetary amounts are integers in cents (e.g., 4995 = $49.95).
{
  "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": "paid",
  "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
    }
  ],
  "order": {
    "id": "ord_xyz789",
    "status": "completed",
    "paid_at": "2026-02-25T15:30:00Z"
  },
  "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",
  "paid_at": "2026-02-25T15:30:00Z"
}

Response Fields

FieldTypeDescription
idstringUnique payment link identifier
urlstringCheckout URL for the payment link
amountintegerTotal amount in cents
statusenumactive, paid, expired, or cancelled
orderobjectAssociated order (present when status is paid)
order.idstringOrder ID
order.statusenumOrder status
order.paid_attimestampWhen payment was completed
paid_attimestampWhen link was paid (null if not paid)

Example

curl https://api.withgale.com/v2/payment-links/plink_abc123xyz \
  -H "Authorization: Bearer glm_test_YOUR_API_KEY"
StatusDescription
activeLink is ready to accept payment
paidPayment completed, order created
expiredLink expired without payment
cancelledLink was manually cancelled

Errors

Status CodeError CodeDescription
401unauthorizedInvalid or missing API key
404not_foundPayment link not found