ActivePerksOrderRequest

data class ActivePerksOrderRequest(val checkoutToken: String, val paymentOption: ActivePerksPaymentOption, val savedCardId: Int? = null, val cardNumber: String? = null, val expirationMonth: Int? = null, val expirationYear: Int? = null, val cvv: String? = null, val billingZip: String? = null, val address1: String? = null, val address2: String? = null, val city: String? = null, val state: String? = null, val country: String? = null, val firstName: String? = null, val lastName: String? = null, val cashbackAmount: Double? = null, val emailReceipt: Boolean? = null, val emailEcodes: Boolean? = null, val cardNickname: String? = null, val externalPaymentMethodIdentifier: Int? = null, val eWalletAmount: Double? = null, val altEmailId: Int? = null)

Payment instruction for completing a gift card order.

Mirrors the server contract field by field. Which optional fields are required depends on paymentOption:

Note: on this endpoint the server takes expirationMonth and expirationYear as numbers, unlike signup and add-payment-method where they are 2-digit strings. That asymmetry is the server's, kept verbatim.

Constructors

Link copied to clipboard
constructor(checkoutToken: String, paymentOption: ActivePerksPaymentOption, savedCardId: Int? = null, cardNumber: String? = null, expirationMonth: Int? = null, expirationYear: Int? = null, cvv: String? = null, billingZip: String? = null, address1: String? = null, address2: String? = null, city: String? = null, state: String? = null, country: String? = null, firstName: String? = null, lastName: String? = null, cashbackAmount: Double? = null, emailReceipt: Boolean? = null, emailEcodes: Boolean? = null, cardNickname: String? = null, externalPaymentMethodIdentifier: Int? = null, eWalletAmount: Double? = null, altEmailId: Int? = null)

Properties

Link copied to clipboard

New card billing address line 1.

Link copied to clipboard

New card billing address line 2.

Link copied to clipboard

Alternate email id to send the ecodes to.

Link copied to clipboard

New card billing ZIP.

Link copied to clipboard

Optional nickname to store the new card under.

Link copied to clipboard

New card number, digits only.

Link copied to clipboard

Cashback balance to apply to the order.

Link copied to clipboard

Token from a previous checkout call.

Link copied to clipboard
val city: String?

New card billing city.

Link copied to clipboard

New card billing country; the server defaults blank to "US".

Link copied to clipboard
val cvv: String?

New card security code.

Link copied to clipboard

Whether the server should email the ecodes.

Link copied to clipboard

Whether the server should email a receipt.

Link copied to clipboard

E-wallet balance to apply to the order.

Link copied to clipboard

New card expiry month as a number (1..12).

Link copied to clipboard

New card expiry year as a number.

Link copied to clipboard

External wallet identifier, when used.

Link copied to clipboard

Cardholder first name.

Link copied to clipboard

Cardholder last name.

Link copied to clipboard

How the order is paid.

Link copied to clipboard

Saved card to charge, for ActivePerksPaymentOption.SAVED_CARD.

Link copied to clipboard

New card billing state code.