GiftGiftCard

recipientUserId
Type: string
min length:
1
required

The unique identifier of the recipient user (provided by Punchh after onboarding).
referenceNumber
Type: string
min length:
1
max length:
40
required

A unique reference number for the transaction.
senderUserId
Type: string
min length:
1
required

The unique identifier of the user gifting the card.
transactionDateTimeUTC
Type: stringFormat: date-time
required

The transaction date and time in UTC format.
amount
Type: number | nullFormat: double

The amount for the new gift card. Required when GiftCardId is not provided.
channel
Type: enum
values
NonePOSKiosk
designId
Type: string
max length:
100

Optional presentation identifier that records which artwork the user selected. Applies to the recipient's copy of the card. It has no effect on payment processing and is never sent to the payment gateway. Only a length limit applies; the value is stored and returned exactly as submitted.
giftCardId
Type: string | null

The gift card ID to transfer. When provided, an existing saved card is transferred to the recipient. When absent, a new virtual gift card is issued and gifted.
invoiceNumber
Type: string | null
max length:
14

A unique invoice number for the transaction.
paymentSource
Type: enum
values
ScanToPayOnlineNone
sourceTransactionId
Type: string | null

The credit card purchase transaction ID. Required when GiftCardId is not provided.
transactionDateTimeLocal
Type: string | nullFormat: date-time

The transaction date and time in local format.

ShareGiftCardResponseModelAPIResponse

GiftGiftCardResponseModel