GET
/
api
/
v1
/
payment-links
curl --request GET \
  --url 'https://brain.orcuspay.com/api/v1/payment-links?limit=10' \
  --header 'x-api-key: ak_prod_xxxxxxxxxxxx' \
  --header 'x-api-secret: sk_prod_xxxxxxxxxxxx'
{
  "data": [
    {
      "id": "pl_abc12345",
      "url": "https://pay.orcuspay.com/aBcDeFgH",
      "slug": "aBcDeFgH",
      "title": "Order Payment",
      "description": null,
      "amount": 1500.00,
      "currency": "BDT",
      "is_reusable": true,
      "is_active": true,
      "current_uses": 3,
      "max_uses": null,
      "expires_at": null,
      "created_at": "2025-03-01T09:00:00.000Z",
      "updated_at": "2025-03-31T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Headers

x-api-key
string
required
Your API access key.
x-api-secret
string
required
Your API secret key.

Query Parameters

limit
number
default:"20"
Number of payment links to return. Maximum 100.
cursor
string
Cursor for pagination. Pass the next_cursor value from the previous response.

Response

data
array
List of payment link objects.
has_more
boolean
Whether there are more results beyond this page.
next_cursor
string
Cursor for the next page. null if no more results.
curl --request GET \
  --url 'https://brain.orcuspay.com/api/v1/payment-links?limit=10' \
  --header 'x-api-key: ak_prod_xxxxxxxxxxxx' \
  --header 'x-api-secret: sk_prod_xxxxxxxxxxxx'
{
  "data": [
    {
      "id": "pl_abc12345",
      "url": "https://pay.orcuspay.com/aBcDeFgH",
      "slug": "aBcDeFgH",
      "title": "Order Payment",
      "description": null,
      "amount": 1500.00,
      "currency": "BDT",
      "is_reusable": true,
      "is_active": true,
      "current_uses": 3,
      "max_uses": null,
      "expires_at": null,
      "created_at": "2025-03-01T09:00:00.000Z",
      "updated_at": "2025-03-31T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}