Easy Labs
APIPaymentsPayment link

Retrieve a payment link

Retrieve a single payment link by ID. Scoped to the authenticated company.

GET
/v1/api/payment-link/{id}

Authorization

apiKey
x-easy-api-key<token>

Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/v1/api/payment-link/string"
{
  "success": true,
  "timestamp": "2026-02-06T12:00:00.000Z",
  "data": {
    "id": "pl_abc123",
    "link_url": "https://pay.example.com/pl_abc123",
    "state": "ACTIVE",
    "nickname": "Premium Widget Payment",
    "payment_link_items": [],
    "created_at": "2026-02-06T12:00:00.000Z"
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}

Deactivate a payment link

Soft-deletes a payment link by setting state=INACTIVE. To re-activate, call PATCH /:id with state=ACTIVE.

List payments for a payment link

Retrieve the orders (payment attempts) that were created against this payment link. Includes purchase items per order. Scoped to the authenticated company.