VirtualIssueRequest

referenceNumber
Type: string
min length:
1
max length:
40
required

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

The source transaction ID for the gift card issue.
transactionDateTimeUTC
Type: stringFormat: date-time
required

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

The amount for which gift card is issued. Pattern: ^\d+(\.\d{0,2})?$ (up to 2 decimal places).
channel
Type: enum
values
NonePOSKiosk
designId
Type: string
max length:
100

Optional presentation identifier that records the artwork selected by the user. 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. When saveCard is false, the value is accepted but has no effect because there is no wallet entry to associate it with.
invoiceNumber
Type: string | null
max length:
14

A unique invoice number for the transaction.
isPreferred
Type: boolean

When true, marks this card as the user's preferred gift card (clears any existing preferred flag).
paymentSource
Type: enum
values
ScanToPayOnlineNone
saveCard
Type: boolean

When true, the issued gift card will be persisted for the user.
transactionDateTimeLocal
Type: string | nullFormat: date-time

The transaction date and time in local format.
userId
Type: string | null

The unique identifier of the user for whom the card is being saved.