Skip to main content
GET
Getgiftcards

Authorizations

Authorization
string
header
required

JWT access token obtained from POST /v2/token.

Headers

X-Eposn-Customer-Token
string | null
X-Eposn-Merchant-Token
string | null

Query Parameters

merchant_id
string | null
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

status
enum<string> | null

Gift card status enumeration.

Available options:
pending,
active,
suspended,
expired,
voided,
depleted
positive_balance
boolean
default:false
programId
string | null
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

cardId
string | null
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

q
string | null
page
integer
default:1
limit
integer
default:250
offset
integer | null

Response

Successful Response