Skip to main content
POST
Search Gift Cards By Code

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
query
string
required

Partial or full gift card code to search for.

Minimum string length: 2

Response

Successful Response

id
string
required
code
string
required
currentBalance
integer
required
status
enum<string>
required
Available options:
PENDING,
ACTIVE,
DISABLED,
VOIDED
purchasingPatientId
string | null
purchasingPatientName
string | null