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'

{
  "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"
}

​
Headers

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

​
Path Parameters

​
id
string
required
The ID of the payment link to retrieve.

​
Response

​
id
string
Unique payment link ID.
​
url
string
The shareable payment link URL.
​
slug
string
The URL slug identifier.
​
title
string
Payment link title.
​
description
string
Description, if provided.
​
amount
number
Amount in BDT (taka).
​
currency
string
Currency code.
​
is_reusable
boolean
Whether the link is reusable.
​
is_active
boolean
Whether the link is currently accepting payments.
​
current_uses
number
Number of successful payments made using this link.
​
max_uses
number
Max uses limit. null for unlimited.
​
expires_at
string
Expiry datetime. null if no expiry.
​
success_url
string
Redirect URL after payment.
​
created_at
string
ISO 8601 timestamp.
​
updated_at
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'

{
  "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"
}