GET
/
payment_link
/
{payment_link_id}
Payments Link - Retrieve
curl --request GET \
  --url https://sandbox.hyperswitch.io/payment_link/{payment_link_id} \
  --header 'api-key: <api-key>'
{
  "payment_link_id": "<string>",
  "merchant_id": "<string>",
  "link_to_pay": "<string>",
  "amount": 6540,
  "created_at": "2023-11-07T05:31:56Z",
  "expiry": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "status": "active",
  "currency": "AED",
  "secure_link": "<string>"
}

Authorizations

​
api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

​
payment_link_id
string
required

The identifier for payment link

Query Parameters

​
client_secret
string | null

This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK

Response

200
application/json

Gets details regarding payment link

The response is of type object.