Skip to main content
POST
Issue Gift Card

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Staff-initiated, random-amount gift card issuance from /settings/gift-cards.

Runs through the regular checkout pipeline: a synthetic archived GiftCardItem carries the requested denomination, the Charge and pending IssuedGiftCard are persisted synchronously so the row appears in the issued list immediately, and the rainforest webhook activates the card once the payin lands.

amount
integer
required

Gift card value in cents.

patientId
string
required

Purchasing patient. Required because the charge pipeline is patient-scoped.

locationId
string | null

Required when the tenant has the LOCATIONS module enabled.

recipientPatientId
string | null

Recipient patient. When omitted, the card belongs to the purchaser.

recipientNote
string | null

Personal message from the sender included in the recipient notification.

scheduledSendDate
string<date-time> | null

When set, the recipient notification is deferred until this time instead of sending immediately on activation.

suppressRecipientNotification
boolean
default:false

When True, the recipient is not auto-notified (neither on activation nor via the scheduled-send heartbeat). Only meaningful when a recipient is set; staff can still send manually later.

code
string | null

Optional provider-entered code. Trimmed and stored uppercase when supplied.

Response

Successful Response

sessionKey
string
required
payinConfigId
string
required
sandbox
boolean
required
paymentMethods
PaymentMethodSummary · object[]