GET
/
v2
/
payments
/
{id}
/
check-gift-card-balance
Payments - Gift Card Balance Check
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/payments/{id}/check-gift-card-balance \
  --header 'Content-Type: application/json' \
  --header 'X-Profile-Id: <x-profile-id>' \
  --header 'api-key: <api-key>' \
  --data '{
  "gift_card_data": {
    "givex": {
      "number": "<string>",
      "cvc": "<string>"
    }
  }
}'
{
  "payment_id": "<string>",
  "balance": 123,
  "currency": "AED",
  "needs_additional_pm_data": true,
  "remaining_amount": 123
}

Authorizations

​
api-key
string
header
required

Publishable keys are a type of keys that can be public and have limited scope of usage.

Headers

​
X-Profile-Id
string
required

Profile ID associated to the payment intent

Path Parameters

​
id
string
required

The global payment id

Body

application/json

Request for Gift Card balance check

​
gift_card_data
object
required

Response

200 - application/json

Get the Gift Card Balance

​
payment_id
string
required

Global Payment Id for the payment

​
balance
integer
required

This Unit struct represents MinorUnit in which core amount works

​
currency
enum<string>
required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

Available options:
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
​
needs_additional_pm_data
boolean
required

Whether the gift card balance is enough for the transaction (Used for split payments case)

​
remaining_amount
integer
required

This Unit struct represents MinorUnit in which core amount works