GET
/
payment_link
/
{payment_link_id}
curl --request GET \
  --url https://sandbox.hyperswitch.io/payment_link/{payment_link_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "client_secret": "<string>"
}'
{
  "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"
}

Authorizations

api-key
string
headerrequired

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

Body

application/json
client_secret
string | null

It's a token used for client side verification.

Response

200 - application/json
payment_link_id
string
required

Identifier for Payment Link

merchant_id
string
required

Identifier for Merchant

link_to_pay
string
required

Payment Link

amount
integer
required

The payment amount. Amount for the payment in the lowest denomination of the currency

created_at
string
required

Date and time of Payment Link creation

expiry
string | null

Date and time of Expiration for Payment Link

description
string | null

Description for Payment Link

status
enum<string>
required

Status Of the Payment Link

Available options:
active,
expired
currency
enum<string>

The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.

Available options:
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
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,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW