AFCore/com.advantahealth.api.activeperks.model

Package-level declarations

ActivePerks data: enrollment, merchants, orders, gift cards, payment methods and cash back.

Types

data class ActivePerksAddress(val address1: String?, val address2: String?, val city: String?, val state: String?, val zip: String?, val countryCode: String?)

Billing address on the member's ActivePerks profile.

ActivePerksCashbackHistory

data class ActivePerksCashbackHistory(val entries: List<ActivePerksCashbackTransaction>, val totalCount: Int)

The member's cashback history.

ActivePerksCashbackRedemption

data class ActivePerksCashbackRedemption(val charityName: String, val address1: String, val address2: String? = null, val city: String, val state: String, val zip: String, val amount: Double)

Details for redeeming cashback to a charity.

ActivePerksCashbackSummary

data class ActivePerksCashbackSummary(val availableBalance: Double, val totalEarned: Double, val totalRedeemed: Double, val totalPending: Double, val canRedeemToCheck: Boolean, val canRedeemToCharity: Boolean)

Cashback totals on the member's ActivePerks profile.

ActivePerksCashbackTransaction

data class ActivePerksCashbackTransaction(val date: String?, val merchant: String?, val transactionType: String?, val cost: Double, val cashbackGiven: Double, val status: String?, val logoUrl: String?, val orderNumber: Int, val orderNumberDetail: Int)

One entry of the member's cashback history.

ActivePerksCharityRedemption

data class ActivePerksCharityRedemption(val charityName: String?, val charityAddress: String?, val charityAddressCont: String?, val charityState: String?, val charityZip: String?)

Charity the member has configured for cashback redemption. All fields are nullable because the server fills only what was captured.

ActivePerksCheckout

data class ActivePerksCheckout(val checkoutToken: String?, val merchantName: String?, val merchantLogoUrl: String?, val quantity: Int, val totalAmount: Double, val cashbackEarnings: Double)

An open gift card checkout with its server-side pricing.

ActivePerksEcode

data class ActivePerksEcode(val ecodeId: Int, val description: String?, val logoUrl: String?, val cashbackPercentage: Double, val isRangeEcode: Boolean, val minimumAmount: Double?, val maximumAmount: Double?, val fixedDenominations: List<Double>)

Digital gift card (ecode) purchase options of a merchant.

ActivePerksEnrollment

data class ActivePerksEnrollment(val isEnrolled: Boolean, val email: String?, val enrollmentState: ActivePerksEnrollmentState?, val enrollmentStatusValue: String?, val needsRecovery: Boolean)

Enrollment status of the authenticated member in ActivePerks.

ActivePerksEnrollmentState

enum ActivePerksEnrollmentState : Enum<ActivePerksEnrollmentState>

Typed view of the server's enrollment status string.

ActivePerksGiftCard

data class ActivePerksGiftCard(val orderNumber: Int, val orderNumberDetail: Int, val merchant: String?, val logoUrl: String?, val denomination: Double, val orderDate: String?, val cardUrl: String?, val archived: Boolean, val orderNotes: String?, val balanceCheck: Boolean)

A gift card in the member's ActivePerks wallet.

ActivePerksGiftCardBalance

data class ActivePerksGiftCardBalance(val balance: String?, val message: String?, val errorCode: Int, val isSuccess: Boolean)

Live balance of one gift card in the member's ActivePerks wallet.

ActivePerksMemberProfile

data class ActivePerksMemberProfile(val username: String?, val email: String?, val firstName: String?, val lastName: String?, val phone: String?, val address: ActivePerksAddress?, val profileName: String?, val profileCode: String?, val renewalText: String?, val hideCancel: Boolean, val logo: String?, val logoFooter: String?, val logoBanner: String?, val primaryCardExpireDate: String?, val cashback: ActivePerksCashbackSummary?, val savedPaymentMethods: List<ActivePerksSavedCard>, val favoriteMerchantIds: List<Int>, val alternateEmails: List<String>, val charityRedemption: ActivePerksCharityRedemption?)

The member's ActivePerks profile - identity, branding, cashback totals, saved payment methods and favorites, exactly as the server reports them.

ActivePerksMerchant

data class ActivePerksMerchant(val merchantId: Int, val name: String?, val logoUrl: String?, val categories: List<String>, val cashbackPercentage: Double, val isFavorite: Boolean)

A merchant in the ActivePerks catalog.

ActivePerksMerchantDetails

data class ActivePerksMerchantDetails(val merchantId: Int, val name: String?, val description: String?, val logoUrl: String?, val buyMessage: String?, val couponLink: String?, val ecode: ActivePerksEcode?, val onlineMall: ActivePerksOnlineMall?)

Full detail of one ActivePerks merchant.

ActivePerksNewPaymentMethod

data class ActivePerksNewPaymentMethod(val cardNumber: String, val expireMonth: String, val expireYear: String, val cvv: String, val address1: String, val address2: String? = null, val city: String, val state: String, val zipCode: String, val country: String = "US", val firstName: String, val lastName: String, val nickname: String? = null)

Card and billing details for adding a payment method to the member's ActivePerks account.

ActivePerksOnlineMall

data class ActivePerksOnlineMall(val onlineMallId: Int, val url: String?, val description: String?, val cashbackPercentage: Double)

Online-mall (affiliate shopping) option of a merchant.

ActivePerksOrderGiftCard

data class ActivePerksOrderGiftCard(val merchant: String?, val logoUrl: String?, val denomination: Double, val orderNumberDetail: Int, val giftCardUrl: String?)

One gift card produced by a completed order.

ActivePerksOrderHistoryEntry

data class ActivePerksOrderHistoryEntry(val orderNumber: Int, val orderNumberDetail: Int, val merchantName: String, val merchantLogoUrl: String, val transactionType: String, val totalAmount: Double, val cashbackEarned: Double, val purchaseDate: String, val status: String)

One past ActivePerks order.

ActivePerksOrderReceipt

data class ActivePerksOrderReceipt(val allGiftCardsReturned: Boolean, val orderNumber: Int, val giftCards: List<ActivePerksOrderGiftCard>)

Result of a completed gift card order.

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.

ActivePerksPaymentMethodAdded

data class ActivePerksPaymentMethodAdded(val savedCardId: Int, val message: String?)

Result of adding a payment method.

ActivePerksPaymentOption

enum ActivePerksPaymentOption : Enum<ActivePerksPaymentOption>

How an ActivePerks order is paid.

ActivePerksSavedCard

data class ActivePerksSavedCard(val savedCardId: Int, val lastFour: String?, val nickname: String?, val isDefault: Boolean)

A payment method saved on the member's ActivePerks account.

ActivePerksSignUpDetails

data class ActivePerksSignUpDetails(val cardNumber: String, val expirationMonth: String, val expirationYear: String, val cvv: String, val address1: String, val address2: String? = null, val city: String, val state: String, val billingZip: String, val phone: String)

Card and billing details for enrolling the member in ActivePerks.