Skip to main content
GET
Get Issued Gift Card Detail

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

gift_card_id
string
required

Response

Successful Response

id
string
required
code
string
required
initialValue
integer
required
currentBalance
integer
required
isActive
boolean
required
status
enum<string>
required
Available options:
PENDING,
ACTIVE,
DISABLED,
VOIDED
createdDate
string<date-time>
required
purchasingPatientId
string | null
purchasingPatientName
string | null
recipientPatientId
string | null
recipientPatientName
string | null
recipientNote
string | null
activatedAt
string<date-time> | null
recipientPatientEmail
string | null
recipientPatientPhone
string | null
chargeItemId
string | null
purchasingPatientEmail
string | null
purchasingPatientPhone
string | null
scheduledSendDate
string<date-time> | null
suppressRecipientNotification
boolean
default:false
notificationSentAt
string<date-time> | null
updatedDate
string<date-time> | null
transactions
GiftCardTransactionDetail · object[]