PayOrc
Payment Link

List Payment Links

Retrieve a paginated list of all payment links with their status, amounts, and metadata.

Version: 3.0.0

Generate an API Key for the Payment Link channel before making requests.

Fetch a paginated list of all payment links associated with your merchant account. Each entry includes the link's configuration, status, amount, and creation timestamps. Use this endpoint to monitor and manage your payment links in bulk.

Endpoint

MethodURL
GEThttps://api.payorc.com/payment-links/v1/list

Please use the test credentials for sandbox testing.

Authentication

HeaderTypeDescription
merchant-keyStringYour merchant key
merchant-secretStringYour merchant secret

Query Parameters

FieldTypeRequiredDescription
perpageNumberYesRecords per page (1 – 1000)
pageNumberYesPage number (1 – 1000)
statusStringNoFilter by status: Active, Deactivated, or Expired
descriptionStringNoFilter by description (max 100 characters)
currencyStringNoFilter by ISO 4217 currency code
is_expiryStringNoFilter by expiry flag: yes or no
expiry_from_dateStringNoStart of expiry date range (YYYY-MM-DD). Requires expiry_to_date
expiry_to_dateStringNoEnd of expiry date range (YYYY-MM-DD). Requires expiry_from_date
amount_conditionStringNoAmount comparison: equal_to, greater_then, less_then, greater_then_equal, or less_then_equal. Use together with amount
amountNumberNoAmount to compare against (min 1). Use together with amount_condition
customer_nameStringNoFilter by customer name (max 50 characters)
customer_emailStringNoFilter by customer email (max 50 characters)
product_detailsStringNoFilter by product details (max 200 characters)

perpage and page are required. When filtering by expiry date, send both expiry_from_date and expiry_to_date. When filtering by amount, send both amount_condition and amount.

Response (200 OK)

FieldTypeDescription
dataArrayList of payment link objects
data[].data_idStringData ID of the payment link
data[].link_idStringHuman-readable link reference number
data[].amountObjectAmount details
data[].amount.currencyStringISO 4217 currency code (3 characters)
data[].amount.valueNumberPayment amount
data[].shipping_feeNumberShipping fee
data[].convenience_feeNumberConvenience fee
data[].no_quantity_per_transactionNumberMaximum quantity per transaction
data[].no_of_transactions_per_userObjectTransaction limits per user
data[].no_of_transactions_per_user.no_limitStringyes if unlimited, no otherwise
data[].no_of_transactions_per_user.frequencyStringFrequency: per_day, per_month, or till_expiry
data[].no_of_transactions_per_user.quantityNumber | StringQuantity allowed, or "No Limit" when no_limit is yes
data[].total_quantity_allowedObjectTotal quantity limits
data[].total_quantity_allowed.no_limitStringyes if unlimited, no otherwise
data[].total_quantity_allowed.frequencyStringFrequency: per_day, per_month, or till_expiry
data[].total_quantity_allowed.quantityNumber | StringQuantity allowed, or "No Limit" when no_limit is yes
data[].link_expiryObjectExpiry configuration
data[].link_expiry.start_dateStringLink start date (DD-MM-YYYY)
data[].link_expiry.is_expiryStringyes if expiry is set, no otherwise
data[].link_expiry.end_dateStringExpiry date (YYYY-MM-DD), or "No expiry" when is_expiry is no
data[].payment_linkStringShareable payment URL
data[].expiry_statusStringExpired, Not Expired, or No expiry date
data[].statusStringActive or Deactivated
data[].final_statusStringOverall lifecycle state: Active, Expired, or Deactivated
data[].qr_codeStringQR code as a base64 image
data[].descriptionStringLink description
data[].error_msgStringCustom error message (if set)
data[].customer_nameStringCustomer name (empty string if not set)
data[].customer_emailStringCustomer email (empty string if not set)
data[].product_detailsStringProduct details (empty string if not set)
data[].m_order_idStringMerchant order ID (empty string if not set)
data[].m_customer_idStringMerchant customer ID (empty string if not set)
data[].customer_mobileStringCustomer mobile number (empty string if not set)
data[].customer_mobile_codeStringMobile country code (empty string if not set)
data[].split_billNumber0 = disabled, 1 = enabled
data[].tipNumber0 = disabled, 1 = enabled
data[].urlsObjectRedirect and webhook URLs configured on this link
data[].urls.successStringSuccess redirect URL (empty string if not set)
data[].urls.failureStringFailure redirect URL (empty string if not set)
data[].urls.cancelStringCancel redirect URL (empty string if not set)
data[].urls.webhook_urlStringWebhook URL for orders from this link (empty string if not set)
data[].created_atStringCreation timestamp (DD-MM-YYYY HH:mm:ss)
data[].updated_atStringLast update timestamp (DD-MM-YYYY HH:mm:ss)
messageStringResponse message
statusStringResponse status
codeStringResponse code (00 on success)
total_recordsNumberTotal number of matching records

Code Examples

curl -X GET "https://api.payorc.com/payment-links/v1/list?perpage=10&page=1" \
  -H "merchant-key: YOUR_MERCHANT_KEY" \
  -H "merchant-secret: YOUR_MERCHANT_SECRET"

Example Response

{
  "data": [
    {
      "data_id": "6a1d4f160b1b43999539e9ad1cc9565d",
      "link_id": "0000002058",
      "amount": {
        "currency": "AED",
        "value": 100
      },
      "shipping_fee": 50,
      "convenience_fee": 20,
      "no_quantity_per_transaction": 9,
      "no_of_transactions_per_user": {
        "no_limit": "no",
        "frequency": "per_day",
        "quantity": 3
      },
      "total_quantity_allowed": {
        "no_limit": "yes",
        "frequency": "per_day",
        "quantity": "No Limit"
      },
      "link_expiry": {
        "start_date": "15-01-2026",
        "is_expiry": "yes",
        "end_date": "2026-12-31"
      },
      "payment_link": "https://checkout.payorc.com/checkout/qr/6a1d4f160b1b43999539e9ad1cc9565d",
      "expiry_status": "Not Expired",
      "status": "Active",
      "final_status": "Active",
      "qr_code": "data:image/png;base64,...",
      "description": "Product purchase",
      "error_msg": "",
      "customer_name": "",
      "customer_email": "",
      "product_details": "Wireless Bluetooth Headphones",
      "m_order_id": "ORD-2026-001",
      "m_customer_id": "CUST-123",
      "customer_mobile": "9876543210",
      "customer_mobile_code": "91",
      "split_bill": 0,
      "tip": 0,
      "urls": {
        "success": "https://merchant.example.com/success",
        "failure": "https://merchant.example.com/failure",
        "cancel": "https://merchant.example.com/cancel",
        "webhook_url": "https://merchant.example.com/webhook"
      },
      "created_at": "15-01-2026 10:30:00",
      "updated_at": "15-01-2026 10:30:00"
    }
  ],
  "message": "List fetched successfully.",
  "status": "success",
  "code": "00",
  "total_records": 1
}

Use final_status in each payment link object to determine the link's overall lifecycle state (Active, Expired, or Deactivated).

Payment Link Details

Fetch complete details of a payment link including status, amount, expiry, and transaction history.

Create Subscription Plan

Create a new subscription plan with billing frequency, installment amounts, terms, and payment details.

On this page

List Payment LinksEndpointAuthenticationQuery ParametersResponse (200 OK)Code ExamplesExample Response