Payment Link Details

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

Payment Link Details

Version: 3.0.0

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

Retrieve the full details of a payment link including its configuration, status, amount, expiry, customer information, and associated transaction list. Use the data_id returned from the create endpoint.

Endpoint

Method	URL
GET	`https://api.payorc.com/payment-links/v1/details?data_id=YOUR_LINK_ID`

Please use the test credentials for sandbox testing.

Authentication

Header	Type	Description
`merchant-key`	String	Your merchant key
`merchant-secret`	String	Your merchant secret

Query Parameters

Field	Type	Required	Description
`data_id`	String	Yes	Data ID of the payment link to fetch

Response (200 OK)

Field	Type	Description
`data`	Object	Payment link details
`data.data_id`	String	Data ID of the payment link
`data.link_id`	String	Human-readable link reference number
`data.amount`	Object	Amount details
`data.amount.currency`	String	ISO 4217 currency code (3 characters)
`data.amount.value`	Number	Payment amount
`data.shipping_fee`	Number	Shipping fee
`data.convenience_fee`	Number	Convenience fee
`data.no_quantity_per_transaction`	Number	Maximum quantity per transaction
`data.no_of_transactions_per_user`	Object	Transaction limits per user
`data.no_of_transactions_per_user.no_limit`	String	`yes` if unlimited, `no` otherwise
`data.no_of_transactions_per_user.frequency`	String	Frequency: `per_day`, `per_month`, or `till_expiry`
`data.no_of_transactions_per_user.quantity`	Number \| String	Quantity allowed, or `"No Limit"` when `no_limit` is `yes`
`data.total_quantity_allowed`	Object	Total quantity limits
`data.total_quantity_allowed.no_limit`	String	`yes` if unlimited, `no` otherwise
`data.total_quantity_allowed.frequency`	String	Frequency: `per_day`, `per_month`, or `till_expiry`
`data.total_quantity_allowed.quantity`	Number \| String	Quantity allowed, or `"No Limit"` when `no_limit` is `yes`
`data.link_expiry`	Object	Expiry configuration
`data.link_expiry.is_expiry`	String	`yes` if expiry is set, `no` otherwise
`data.link_expiry.end_date`	String	Expiry date (`YYYY-MM-DD`), or `"No expiry"` when `is_expiry` is `no`
`data.payment_link`	String	Shareable payment URL
`data.description`	String	Link description
`data.error_msg`	String	Custom error message (if set)
`data.status`	String	`Activated` or `Deactivated`
`data.payment_list`	Array	Transaction list for this payment link
`data.qr_code`	String	QR code as base64 image
`data.customer_name`	String	Customer name (empty string if not set)
`data.customer_email`	String	Customer email (empty string if not set)
`data.product_details`	String	Product details (empty string if not set)
`data.m_order_id`	String	Merchant order ID (empty string if not set)
`data.m_customer_id`	String	Merchant customer ID (empty string if not set)
`data.customer_mobile`	String	Customer mobile number (empty string if not set)
`data.customer_mobile_code`	String	Mobile country code (empty string if not set)
`data.split_bill`	Number	`0` = disabled, `1` = enabled
`data.tip`	Number	`0` = disabled, `1` = enabled
`data.urls`	Object	Redirect and webhook URLs configured on this link
`data.urls.success`	String	Success redirect URL (empty string if not set)
`data.urls.failure`	String	Failure redirect URL (empty string if not set)
`data.urls.cancel`	String	Cancel redirect URL (empty string if not set)
`data.urls.webhook_url`	String	Webhook URL for orders from this link (empty string if not set)
`message`	String	Response message
`status`	String	Response status
`code`	String	Response code (`00` on success)

Code Examples

curl -X GET "https://api.payorc.com/payment-links/v1/details?data_id=lnk_8x7kP2mN4qR" \
  -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": {
      "is_expiry": "yes",
      "end_date": "2026-12-31"
    },
    "payment_link": "https://checkout.payorc.com/checkout/qr/6a1d4f160b1b43999539e9ad1cc9565d",
    "description": "Product purchase",
    "error_msg": "",
    "status": "Activated",
    "payment_list": [],
    "qr_code": "data:image/png;base64,...",
    "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"
    }
  },
  "message": "Details fetched successfully.",
  "status": "success",
  "code": "00"
}

Error Response

{
  "message": "Invalid id.",
  "status": "fail",
  "code": "E0044"
}

Payment Link Details

On this page