PaymentMethod

public enum PaymentMethod : Equatable

Representing how a user will pay for their visit

  • Pay on arrival at retail clinic

    Declaration

    Swift

    case `self`

  • Payment with coupon code

    Declaration

    Swift

    case couponCode(String)

  • Payment with credit card

    Declaration

    Swift

    case creditCard(stripeToken: String)

    Parameters

    stripeToken

    a generated Stripe Token used for payment

  • Undocumented

    Declaration

    Swift

    case insuranceManualSelf(memberId: String, providerId: String, insuranceGroupNumber: String? = nil)

  • Payment by typing my own insurance information to form

    Declaration

    Swift

    case insuranceManualSelfWithPayor(memberId: String, payorId: String, insuranceGroupNumber: String? = nil, payorName: String? = nil)

    Parameters

    memberId

    a user’s unique id for their insurance provider
    payorId

    a unique id representing the insurance provider. The supported list can be retrieved by calling VirtualService.getInsurancePayers
    insuranceGroupNumber

    an optional parameter to include group numbers
    payorName

    an optional parameter to include the Insurance Provider/Payor name. The supported list can be retrieved by calling VirtualService.getInsurancePayers

  • Undocumented

    Declaration

    Swift

    case insuranceManualOther(firstName: String, lastName: String, gender: Gender, dateOfBirth: Date, memberId: String, providerId: String, insuranceGroupNumber: String? = nil)

  • Payment by typing someone else’s insurance information into a form

    Declaration

    Swift

    case insuranceManualOtherWithPayor(firstName: String, lastName: String, gender: Gender, dateOfBirth: Date, memberId: String, payorId: String, insuranceGroupNumber: String? = nil, payorName: String? = nil, subscriberId: String? = nil)

    Parameters

    firstName

    the given name of the insured person
    lastName

    the family name of the insured person
    gender

    the Gender of the insured person
    dateOfBirth

    the birth date of the insured person
    memberId

    the unique id of the insured person for their insurance provider
    payorId

    a unique id representing the insurance provider. The supported list can be retrieved by calling VirtualService.getInsurancePayers
    insuranceGroupNumber

    an optional parameter to include group number
    payorName

    an optional parameter to include the Insurance Provider/Payor name. The supported list can be retrieved by calling VirtualService.getInsurancePayers
    subscriberId

    an optional parameter when insurance providers require it

  • Undocumented

    Declaration

    Swift

    case insuranceImageSelf(cardId: String)

  • Payment by submitting a photo of someone else’s insurance card

    Declaration

    Swift

    case insuranceImageOther(firstName: String, lastName: String, gender: Gender, dateOfBirth: Date, cardId: String)

    Parameters

    cardId

    the id of the previously uploaded card. This can be retrieved by calling RetailService.uploadInsuranceCard first.