curl --request GET \
--url 'https://brain.orcuspay.com/api/v1/payment-links/pl_abc12345' \
--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/pl_abc12345',
{
headers: {
'x-api-key': 'ak_prod_xxxxxxxxxxxx',
'x-api-secret': 'sk_prod_xxxxxxxxxxxx',
},
}
)
const link = await res.json()
{
"id": "pl_abc12345",
"url": "https://pay.orcuspay.com/aBcDeFgH",
"slug": "aBcDeFgH",
"title": "Order #1234",
"description": "Payment for your recent order",
"amount": 1500.00,
"currency": "BDT",
"is_reusable": false,
"is_active": true,
"current_uses": 1,
"max_uses": null,
"expires_at": null,
"success_url": "https://yourstore.com/thank-you",
"created_at": "2025-04-04T10:00:00.000Z",
"updated_at": "2025-04-04T10:05:00.000Z"
}
{
"error": "Payment link not found"
}
Payment Links
Retrieve a Payment Link
Retrieves the details of an existing payment link.
GET
/
api
/
v1
/
payment-links
/
{id}
curl --request GET \
--url 'https://brain.orcuspay.com/api/v1/payment-links/pl_abc12345' \
--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/pl_abc12345',
{
headers: {
'x-api-key': 'ak_prod_xxxxxxxxxxxx',
'x-api-secret': 'sk_prod_xxxxxxxxxxxx',
},
}
)
const link = await res.json()
{
"id": "pl_abc12345",
"url": "https://pay.orcuspay.com/aBcDeFgH",
"slug": "aBcDeFgH",
"title": "Order #1234",
"description": "Payment for your recent order",
"amount": 1500.00,
"currency": "BDT",
"is_reusable": false,
"is_active": true,
"current_uses": 1,
"max_uses": null,
"expires_at": null,
"success_url": "https://yourstore.com/thank-you",
"created_at": "2025-04-04T10:00:00.000Z",
"updated_at": "2025-04-04T10:05:00.000Z"
}
{
"error": "Payment link not found"
}
Headers
string
required
Your API access key.
string
required
Your API secret key.
Path Parameters
string
required
The ID of the payment link to retrieve.
Response
string
Unique payment link ID.
string
The shareable payment link URL.
string
The URL slug identifier.
string
Payment link title.
string
Description, if provided.
number
Amount in BDT (taka).
string
Currency code.
boolean
Whether the link is reusable.
boolean
Whether the link is currently accepting payments.
number
Number of successful payments made using this link.
number
Max uses limit.
null for unlimited.string
Expiry datetime.
null if no expiry.string
Redirect URL after payment.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
curl --request GET \
--url 'https://brain.orcuspay.com/api/v1/payment-links/pl_abc12345' \
--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/pl_abc12345',
{
headers: {
'x-api-key': 'ak_prod_xxxxxxxxxxxx',
'x-api-secret': 'sk_prod_xxxxxxxxxxxx',
},
}
)
const link = await res.json()
{
"id": "pl_abc12345",
"url": "https://pay.orcuspay.com/aBcDeFgH",
"slug": "aBcDeFgH",
"title": "Order #1234",
"description": "Payment for your recent order",
"amount": 1500.00,
"currency": "BDT",
"is_reusable": false,
"is_active": true,
"current_uses": 1,
"max_uses": null,
"expires_at": null,
"success_url": "https://yourstore.com/thank-you",
"created_at": "2025-04-04T10:00:00.000Z",
"updated_at": "2025-04-04T10:05:00.000Z"
}
{
"error": "Payment link not found"
}