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'
const res = await fetch('https://brain.orcuspay.com/api/v1/payment-links?limit=10', {
headers: {
'x-api-key': 'ak_prod_xxxxxxxxxxxx',
'x-api-secret': 'sk_prod_xxxxxxxxxxxx',
},
})
const data = await res.json()
{
"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
}
Payment Links
List Payment Links
Returns a paginated list of payment links for your business.
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'
const res = await fetch('https://brain.orcuspay.com/api/v1/payment-links?limit=10', {
headers: {
'x-api-key': 'ak_prod_xxxxxxxxxxxx',
'x-api-secret': 'sk_prod_xxxxxxxxxxxx',
},
})
const data = await res.json()
{
"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
string
required
Your API access key.
string
required
Your API secret key.
Query Parameters
number
default:"20"
Number of payment links to return. Maximum
100.string
Cursor for pagination. Pass the
next_cursor value from the previous response.Response
array
List of payment link objects.
Show Payment link object
Show Payment link object
string
Unique payment link ID.
string
The shareable payment link URL.
string
The URL slug identifier.
string
Payment link title.
string
Optional description.
number
Amount in BDT (taka).
string
Currency code. Always
BDT.boolean
Whether multiple customers can pay using this link.
boolean
Whether the link is currently active.
number
Number of times this link has been used.
number
Maximum number of uses allowed.
null for unlimited.string
Expiry timestamp.
null if no expiry set.string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
boolean
Whether there are more results beyond this page.
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'
const res = await fetch('https://brain.orcuspay.com/api/v1/payment-links?limit=10', {
headers: {
'x-api-key': 'ak_prod_xxxxxxxxxxxx',
'x-api-secret': 'sk_prod_xxxxxxxxxxxx',
},
})
const data = await res.json()
{
"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
}