Payments Link - Retrieve

Retrieve details for a payment link.

Request

GET https://sandbox.hyperswitch.io/payment_link/{payment_link_id}

Headers:

• api-key: <api-key>

cURL

cURL

curl --request GET \
  --url https://sandbox.hyperswitch.io/payment_link/{payment_link_id} \
  --header 'api-key: <api-key>'

Path Parameters

• payment_link_id (string, required) The identifier for the 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.

Authorization

• 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.

Response — 200 application/json

Gets details regarding the payment link.

Example body:

Response (200)

{
  "payment_link_id": "<string>",
  "merchant_id": "<string>",
  "link_to_pay": "<string>",
  "amount": 6540,
  "created_at": "2023-11-07T05:31:56Z",
  "status": "active",
  "expiry": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "currency": "AED",
  "secure_link": "<string>"
}

Response fields:

• payment_link_id (string, required) Identifier for Payment Link.

• merchant_id (string, required) Identifier for Merchant.

• link_to_pay (string, required) Open payment link (without any security checks and listing SPMs).

• amount (integer, required) The payment amount in the lowest denomination of the currency. Example: 6540

• created_at (string, required) Date and time of Payment Link creation.

• status (enum, required) Status of the Payment Link. Available options: active, expired.

• expiry (string | null) Date and time of expiration for the Payment Link.

• description (string | null) Description for the Payment Link.

• currency (enum) The three-letter ISO 4217 currency code for the payment amount. This field is mandatory for creating a payment. Available options include (not exhaustive):

  AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL

• secure_link (string | null) Secure payment link (with security checks and listing saved payment methods).

Links

• Documentation: https://api-reference.hyperswitch.io/introduction

• Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

• Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

• Edit docs: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/payments/payments-link--retrieve.mdx

• Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/payments/payments-link--retrieve

Was this page helpful? Yes / No