commerce

List payment links

The 25 most recent payment links (each an order with a Paystack checkout URL, with its paid/pending state) or, with reference, that one link.

A row is a payment link iff checkout_url is set; storefront orders live under /commerce/orders.

reference (optional) returns only the link with that exact reference, such as an order's own reference, in the same shape: orders is empty when none of yours has it. An empty or over-long value is a 400 validation_failed.

status becomes paid only when the signed Paystack webhook lands. Never trust a buyer's redirect.

get/api/v1/commerce/payment-links

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/commerce/payment-links
  • Auth: HTTP bearer

Query parameters

referencestring

Filter by reference.

Response

Success

okboolean required

Example response

{
  "ok": true,
  "orders": [
    {
      "id": "0e336439-8c7a-49c6-9e96-20b1f8887a5a",
      "reference": "bt_9775b4c2d89ada56abeb55dd",
      "amount_cents": 45000,
      "currency": "ZAR",
      "checkout_url": "https://checkout.paystack.com/xglrxrmjurl91ln",
      "created_at": "2026-08-05T09:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.