POST
/
api
/
v1
/
payment-links
curl --request POST \
  --url 'https://brain.orcuspay.com/api/v1/payment-links' \
  --header 'x-api-key: ak_prod_xxxxxxxxxxxx' \
  --header 'x-api-secret: sk_prod_xxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --data '{
    "title": "Order #1234",
    "amount": 1500,
    "description": "Payment for your recent order",
    "is_reusable": false,
    "success_url": "https://yourstore.com/thank-you"
  }'
{
  "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": 0,
  "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:00:00.000Z"
}

Headers

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

Body

title
string
required
A short title for the payment (e.g. “Order #1234” or “Monthly subscription”).
amount
number
required
Payment amount in taka (e.g. 500 for ৳500).
description
string
Optional description shown to the customer on the payment page.
currency
string
default:"BDT"
Currency code. Currently only BDT is supported.
is_reusable
boolean
default:"false"
Set to true to allow multiple customers to pay using the same link. When false, the link deactivates after the first successful payment.
max_uses
number
Maximum number of successful payments allowed. Only applicable when is_reusable is true. Omit for unlimited uses.
expires_at
string
ISO 8601 datetime string after which the link will no longer accept payments (e.g. "2025-12-31T23:59:59Z"). Omit for no expiry.
success_url
string
URL to redirect the customer to after a successful payment.

Response

Returns the newly created payment link object.
id
string
Unique payment link ID.
url
string
The shareable payment link URL to send to your customers.
slug
string
The URL slug identifier.
title
string
Payment link title.
description
string
Description, if provided.
amount
number
Amount in BDT.
currency
string
Currency code.
is_reusable
boolean
Whether the link is reusable.
is_active
boolean
Always true on creation.
current_uses
number
Always 0 on creation.
max_uses
number
Max uses limit, if set.
expires_at
string
Expiry datetime, if set.
success_url
string
Redirect URL after payment.
created_at
string
ISO 8601 timestamp.
updated_at
string
ISO 8601 timestamp.
curl --request POST \
  --url 'https://brain.orcuspay.com/api/v1/payment-links' \
  --header 'x-api-key: ak_prod_xxxxxxxxxxxx' \
  --header 'x-api-secret: sk_prod_xxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --data '{
    "title": "Order #1234",
    "amount": 1500,
    "description": "Payment for your recent order",
    "is_reusable": false,
    "success_url": "https://yourstore.com/thank-you"
  }'
{
  "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": 0,
  "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:00:00.000Z"
}