TicketUserServices

OwnerCardsUpgradeRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Requires the permission:	ReadData

The following routes are available for this service:
POST	/OrderOwnerCards/upgrade	Charge the delta, issue the target card (PricePaid = delta), revoke the source card, re-link future tickets — one transaction, idempotent

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GeneralOrderResponse:
    status_code: Optional[int] = None
    message: Optional[str] = None
    success: Optional[bool] = None
    payment_is_pending: Optional[bool] = None
    order_token_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerCards:
    id: Optional[int] = None
    owner_id: Optional[int] = None
    owner_card_type_id: Optional[int] = None
    phone_verification_id: Optional[int] = None
    initial_max_tickets: Optional[int] = None
    current_available_tickets: Optional[int] = None
    time_stamp_created_u_t_c: Optional[datetime.datetime] = None
    time_stamp_last_changed_u_t_c: Optional[datetime.datetime] = None
    time_stamp_bought_u_t_c: Optional[datetime.datetime] = None
    time_stamp_ordered_u_t_c: Optional[datetime.datetime] = None
    card_valid_from_u_t_c: Optional[datetime.datetime] = None
    card_valid_to_u_t_c: Optional[datetime.datetime] = None
    has_store_credit: Optional[bool] = None
    card_price: Optional[Decimal] = None
    price_paid: Optional[Decimal] = None
    initial_store_credit: Optional[Decimal] = None
    current_store_credit: Optional[Decimal] = None
    phone_full_verification_number: Optional[str] = None
    holder_id: Optional[str] = None
    holder_name: Optional[str] = None
    holder_email: Optional[str] = None
    card_price_currency: Optional[str] = None
    price_paid_currency: Optional[str] = None
    device_id: Optional[str] = None
    payment_method_id: Optional[str] = None
    payment_reference: Optional[str] = None
    phone_verification_number: Optional[str] = None
    payment_phone_number: Optional[str] = None
    payment_id: Optional[str] = None
    payment_status: Optional[str] = None
    payment_token_id: Optional[str] = None
    max_tickets_per_event: Optional[int] = None
    multiple_payments_id: Optional[str] = None
    image_url: Optional[str] = None
    background_image_url: Optional[str] = None
    order_reference: Optional[str] = None
    upgraded_from_owner_card_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerCardsOrderResult(GeneralOrderResponse):
    cards: Optional[List[OwnerCards]] = None
    order_reference: Optional[str] = None
    is_subscription: Optional[bool] = None
    monthly_price: Optional[Decimal] = None
    transaction_fee: Optional[Decimal] = None
    months: Optional[int] = None
    payment_token_id: Optional[str] = None
    subscription_token_missing: Optional[bool] = None
    price_total: Optional[int] = None
    discount_amount: Optional[int] = None
    gift_card_amount: Optional[int] = None
    donation_amount: Optional[int] = None
    charged_amount: Optional[int] = None
    reason: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerCardsUpgradeResult(OwnerCardsOrderResult):
    source_owner_card_id: Optional[int] = None
    source_owner_card_type_id: Optional[int] = None
    source_type_name: Optional[str] = None
    new_owner_card_id: Optional[int] = None
    target_owner_card_type_id: Optional[int] = None
    target_type_name: Optional[str] = None
    relinked_tickets: Optional[int] = None
    payment_reference: Optional[str] = None
    refund_pending: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Borgun3DFinalPaymentMethodInfo:
    payment_type: Optional[str] = None
    token: Optional[str] = None
    virtual_number: Optional[str] = None
    exp_year: Optional[str] = None
    exp_month: Optional[str] = None
    pan_last_four: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Borgun3DFinal3DSecureInfo:
    data_type: Optional[str] = None
    mpi_token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Borgun3DFinalRequest:
    transaction_type: Optional[str] = None
    amount: Optional[int] = None
    currency: Optional[str] = None
    transaction_date: Optional[datetime.datetime] = None
    order_id: Optional[str] = None
    payment_method: Optional[Borgun3DFinalPaymentMethodInfo] = None
    three_d_secure: Optional[Borgun3DFinal3DSecureInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderTender:
    kind: Optional[str] = None
    code: Optional[str] = None
    amount_minor: Optional[int] = None
    idempotency_key: Optional[str] = None
    hold_id: Optional[int] = None
    applied_minor: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerCardsUpgradeRequest:
    buyer_phone: Optional[str] = None
    source_owner_card_id: Optional[int] = None
    target_owner_card_type_id: Optional[int] = None
    idempotency_key: Optional[str] = None
    payment_method_id: Optional[str] = None
    borgun3_d_final_info: Optional[Borgun3DFinalRequest] = None
    tenders: Optional[List[OrderTender]] = None
    holder_name: Optional[str] = None
    holder_email: Optional[str] = None
    device_id: Optional[str] = None
    return_cards: Optional[bool] = None

Python OwnerCardsUpgradeRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /OrderOwnerCards/upgrade HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OwnerCardsUpgradeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Borgun3DFinalInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BorgunRPGData">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:OrderId>String</d2p1:OrderId>
    <d2p1:PaymentMethod>
      <d2p1:ExpMonth>String</d2p1:ExpMonth>
      <d2p1:ExpYear>String</d2p1:ExpYear>
      <d2p1:PanLastFour>String</d2p1:PanLastFour>
      <d2p1:PaymentType>String</d2p1:PaymentType>
      <d2p1:Token>String</d2p1:Token>
      <d2p1:VirtualNumber>String</d2p1:VirtualNumber>
    </d2p1:PaymentMethod>
    <d2p1:ThreeDSecure>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:MpiToken>String</d2p1:MpiToken>
    </d2p1:ThreeDSecure>
    <d2p1:TransactionDate>0001-01-01T00:00:00</d2p1:TransactionDate>
    <d2p1:TransactionType>String</d2p1:TransactionType>
  </Borgun3DFinalInfo>
  <BuyerPhone>String</BuyerPhone>
  <DeviceId>String</DeviceId>
  <HolderEmail>String</HolderEmail>
  <HolderName>String</HolderName>
  <IdempotencyKey>String</IdempotencyKey>
  <PaymentMethodId>String</PaymentMethodId>
  <ReturnCards>false</ReturnCards>
  <SourceOwnerCardId>0</SourceOwnerCardId>
  <TargetOwnerCardTypeId>0</TargetOwnerCardTypeId>
  <Tenders>
    <OrderTender>
      <AmountMinor>0</AmountMinor>
      <AppliedMinor>0</AppliedMinor>
      <Code>String</Code>
      <HoldId>0</HoldId>
      <IdempotencyKey>String</IdempotencyKey>
      <Kind>String</Kind>
    </OrderTender>
  </Tenders>
</OwnerCardsUpgradeRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OwnerCardsUpgradeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <OrderTokenId>String</OrderTokenId>
  <PaymentIsPending>false</PaymentIsPending>
  <StatusCode>0</StatusCode>
  <Success>false</Success>
  <Cards xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:OwnerCards>
      <d2p1:BackgroundImageUrl>String</d2p1:BackgroundImageUrl>
      <d2p1:CardPrice>0</d2p1:CardPrice>
      <d2p1:CardPriceCurrency>String</d2p1:CardPriceCurrency>
      <d2p1:CardValidFromUTC>0001-01-01T00:00:00</d2p1:CardValidFromUTC>
      <d2p1:CardValidToUTC>0001-01-01T00:00:00</d2p1:CardValidToUTC>
      <d2p1:CurrentAvailableTickets>0</d2p1:CurrentAvailableTickets>
      <d2p1:CurrentStoreCredit>0</d2p1:CurrentStoreCredit>
      <d2p1:DeviceId>String</d2p1:DeviceId>
      <d2p1:HasStoreCredit>false</d2p1:HasStoreCredit>
      <d2p1:HolderEmail>String</d2p1:HolderEmail>
      <d2p1:HolderId>String</d2p1:HolderId>
      <d2p1:HolderName>String</d2p1:HolderName>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:ImageUrl>String</d2p1:ImageUrl>
      <d2p1:InitialMaxTickets>0</d2p1:InitialMaxTickets>
      <d2p1:InitialStoreCredit>0</d2p1:InitialStoreCredit>
      <d2p1:MaxTicketsPerEvent>0</d2p1:MaxTicketsPerEvent>
      <d2p1:MultiplePaymentsId>String</d2p1:MultiplePaymentsId>
      <d2p1:OrderReference>String</d2p1:OrderReference>
      <d2p1:OwnerCardTypeId>0</d2p1:OwnerCardTypeId>
      <d2p1:OwnerId>0</d2p1:OwnerId>
      <d2p1:PaymentId>String</d2p1:PaymentId>
      <d2p1:PaymentMethodId>String</d2p1:PaymentMethodId>
      <d2p1:PaymentPhoneNumber>String</d2p1:PaymentPhoneNumber>
      <d2p1:PaymentReference>String</d2p1:PaymentReference>
      <d2p1:PaymentStatus>String</d2p1:PaymentStatus>
      <d2p1:PaymentTokenId>String</d2p1:PaymentTokenId>
      <d2p1:PhoneFullVerificationNumber>String</d2p1:PhoneFullVerificationNumber>
      <d2p1:PhoneVerificationId>0</d2p1:PhoneVerificationId>
      <d2p1:PhoneVerificationNumber>String</d2p1:PhoneVerificationNumber>
      <d2p1:PricePaid>0</d2p1:PricePaid>
      <d2p1:PricePaidCurrency>String</d2p1:PricePaidCurrency>
      <d2p1:TimeStampBoughtUTC>0001-01-01T00:00:00</d2p1:TimeStampBoughtUTC>
      <d2p1:TimeStampCreatedUTC>0001-01-01T00:00:00</d2p1:TimeStampCreatedUTC>
      <d2p1:TimeStampLastChangedUTC>0001-01-01T00:00:00</d2p1:TimeStampLastChangedUTC>
      <d2p1:TimeStampOrderedUTC>0001-01-01T00:00:00</d2p1:TimeStampOrderedUTC>
      <d2p1:UpgradedFromOwnerCardId>0</d2p1:UpgradedFromOwnerCardId>
    </d2p1:OwnerCards>
  </Cards>
  <ChargedAmount>0</ChargedAmount>
  <DiscountAmount>0</DiscountAmount>
  <DonationAmount>0</DonationAmount>
  <GiftCardAmount>0</GiftCardAmount>
  <IsSubscription>false</IsSubscription>
  <MonthlyPrice>0</MonthlyPrice>
  <Months>0</Months>
  <OrderReference>String</OrderReference>
  <PaymentTokenId>String</PaymentTokenId>
  <PriceTotal>0</PriceTotal>
  <Reason>String</Reason>
  <SubscriptionTokenMissing>false</SubscriptionTokenMissing>
  <TransactionFee>0</TransactionFee>
  <NewOwnerCardId>0</NewOwnerCardId>
  <PaymentReference>String</PaymentReference>
  <RefundPending>false</RefundPending>
  <RelinkedTickets>0</RelinkedTickets>
  <SourceOwnerCardId>0</SourceOwnerCardId>
  <SourceOwnerCardTypeId>0</SourceOwnerCardTypeId>
  <SourceTypeName>String</SourceTypeName>
  <TargetOwnerCardTypeId>0</TargetOwnerCardTypeId>
  <TargetTypeName>String</TargetTypeName>
</OwnerCardsUpgradeResult>