API Documentation

Interface

DigitalPayGiftingProductDetail

DigitalPayGiftingProductDetail

Gift card product detailed data

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 4

Members

"DIGITAL" | "PHYSICAL" | "BOTH"

# availability

Digital or phyiscal availability of the gift card

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 51

Array

# designs

Array of all alternative designs for the gift card product

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 55

number

# expiryPeriodInDays Optional

Expiry period for the gift card product once purchased

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 32

string

# expiryPeriodText Optional

Display text for the expiry period

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 37

boolean

# isActive

Returns true if the gift card product is active, else false. Only active programs are orderable

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 42

number

# maxValue

Maximum AUD value gift card able to be purchased for this product

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 28

number

# minValue

Minimum AUD value gift card able to be purchased for this product

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 24

string

# redemptionInstructions Optional

Display instruction on where and how to redeem the product

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 10

Array

# redemptionStores Optional

The stores in which the gift card product is able to be redeemed

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 46

"INSTORE" | "ONLINE" | "BOTH"

# redemptionType

The enabled redemption channels

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 15

string

# termsAndConditions Optional

Terms and conditions text for the gift card product

View Source model/DigiPayModel/DigitalPayGiftingProductDetail.d.ts, line 19