TicketUserServices

<back to all web services

OwnerCardsOrderRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileApp, Admin, TeamAdmin, MobileAppRequires any of the permissions:ReadData, ReadData
The following routes are available for this service:
POST/OrderOwnerCards

export class GeneralOrderResponse
{
    public statusCode?: number;
    public message?: string;
    public success?: boolean;
    public paymentIsPending?: boolean;
    public orderTokenId?: string;

    public constructor(init?: Partial<GeneralOrderResponse>) { (Object as any).assign(this, init); }
}

export class OwnerCards
{
    public id?: number;
    public ownerId?: number;
    public ownerCardTypeId?: number;
    public phoneVerificationId?: number;
    public initialMaxTickets?: number;
    public currentAvailableTickets?: number;
    public timeStampCreatedUTC?: string;
    public timeStampLastChangedUTC?: string;
    public timeStampBoughtUTC?: string;
    public timeStampOrderedUTC?: string;
    public cardValidFromUTC?: string;
    public cardValidToUTC?: string;
    public hasStoreCredit?: boolean;
    public cardPrice?: number;
    public pricePaid?: number;
    public initialStoreCredit?: number;
    public currentStoreCredit?: number;
    public phoneFullVerificationNumber?: string;
    public holderId?: string;
    public holderName?: string;
    public holderEmail?: string;
    public cardPriceCurrency?: string;
    public pricePaidCurrency?: string;
    public deviceId?: string;
    public paymentMethodId?: string;
    public paymentReference?: string;
    public phoneVerificationNumber?: string;
    public paymentPhoneNumber?: string;
    public paymentId?: string;
    public paymentStatus?: string;
    public paymentTokenId?: string;
    public maxTicketsPerEvent?: number;
    public multiplePaymentsId?: string;
    public imageUrl?: string;
    public backgroundImageUrl?: string;
    public orderReference?: string;
    public upgradedFromOwnerCardId?: number;

    public constructor(init?: Partial<OwnerCards>) { (Object as any).assign(this, init); }
}

export class OwnerCardsOrderResult extends GeneralOrderResponse
{
    public cards?: OwnerCards[];
    public orderReference?: string;
    public isSubscription?: boolean;
    public monthlyPrice?: number;
    public transactionFee?: number;
    public months?: number;
    public paymentTokenId?: string;
    public subscriptionTokenMissing?: boolean;
    public priceTotal?: number;
    public discountAmount?: number;
    public giftCardAmount?: number;
    public donationAmount?: number;
    public chargedAmount?: number;
    public reason?: string;

    public constructor(init?: Partial<OwnerCardsOrderResult>) { super(init); (Object as any).assign(this, init); }
}

export class PaymentMethodCreditCardInfo
{
    public paymentType?: string;
    public token?: string;
    public pan?: string;
    public expYear?: string;
    public expMonth?: string;
    public cvc?: string;

    public constructor(init?: Partial<PaymentMethodCreditCardInfo>) { (Object as any).assign(this, init); }
}

export class PaymentRequestCreditCard
{
    public paymentMethod?: PaymentMethodCreditCardInfo;
    public amount?: number;
    public currency?: string;
    public orderId?: string;
    public transActionDate?: string;
    public saveCardToToken?: boolean;

    public constructor(init?: Partial<PaymentRequestCreditCard>) { (Object as any).assign(this, init); }
}

export class BorgunApplePayThreeDSecureInfo
{
    public dataType?: string;
    public securityLevelInd?: string;
    public cavv?: string;
    public ucaf?: string;

    public constructor(init?: Partial<BorgunApplePayThreeDSecureInfo>) { (Object as any).assign(this, init); }
}

export class BorgunApplePayFinalInfo
{
    public orderId?: string;
    public threeDSecure?: BorgunApplePayThreeDSecureInfo;

    public constructor(init?: Partial<BorgunApplePayFinalInfo>) { (Object as any).assign(this, init); }
}

export class Borgun3DFinalPaymentMethodInfo
{
    public paymentType?: string;
    public token?: string;
    public virtualNumber?: string;
    public expYear?: string;
    public expMonth?: string;
    public panLastFour?: string;

    public constructor(init?: Partial<Borgun3DFinalPaymentMethodInfo>) { (Object as any).assign(this, init); }
}

export class Borgun3DFinal3DSecureInfo
{
    public dataType?: string;
    public mpiToken?: string;

    public constructor(init?: Partial<Borgun3DFinal3DSecureInfo>) { (Object as any).assign(this, init); }
}

export class Borgun3DFinalRequest
{
    public transactionType?: string;
    public amount?: number;
    public currency?: string;
    public transactionDate?: string;
    public orderId?: string;
    public paymentMethod?: Borgun3DFinalPaymentMethodInfo;
    public threeDSecure?: Borgun3DFinal3DSecureInfo;

    public constructor(init?: Partial<Borgun3DFinalRequest>) { (Object as any).assign(this, init); }
}

export class OrderTender
{
    public kind?: string;
    public code?: string;
    public amountMinor?: number;
    public idempotencyKey?: string;
    public holdId?: number;
    public appliedMinor?: number;

    public constructor(init?: Partial<OrderTender>) { (Object as any).assign(this, init); }
}

export class RequestSignature
{
    public systemId?: string;
    public systemSecret?: string;
    public signature?: string;

    public constructor(init?: Partial<RequestSignature>) { (Object as any).assign(this, init); }
}

export class OwnerCardsOrderRequest
{
    public ownerCardTypeIds?: number[];
    public paymentMethodId?: string;
    public cardInfo?: PaymentRequestCreditCard;
    public applePayInfo?: BorgunApplePayFinalInfo;
    public borgun3DFinalInfo?: Borgun3DFinalRequest;
    public paymentPhoneNumber?: string;
    public appMetaData?: string;
    public holderId?: string;
    public holderName?: string;
    public holderEmail?: string;
    public returnCards?: boolean;
    public phoneVerificationNumber?: string;
    public deviceId?: string;
    public discountCode?: string;
    public tenders?: OrderTender[];
    public idempotencyKey?: string;
    public isSubscription?: boolean;
    public donationAmount?: number;
    public requestUnixUTCTimeStamp?: number;
    public signature?: RequestSignature;

    public constructor(init?: Partial<OwnerCardsOrderRequest>) { (Object as any).assign(this, init); }
}

TypeScript OwnerCardsOrderRequest 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 HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OwnerCardsOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AppMetaData>String</AppMetaData>
  <ApplePayInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BorgunRPGData">
    <d2p1:OrderId>String</d2p1:OrderId>
    <d2p1:ThreeDSecure>
      <d2p1:CAVV>String</d2p1:CAVV>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:SecurityLevelInd>String</d2p1:SecurityLevelInd>
      <d2p1:UCAF>String</d2p1:UCAF>
    </d2p1:ThreeDSecure>
  </ApplePayInfo>
  <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>
  <CardInfo>
    <Amount>0</Amount>
    <Currency>String</Currency>
    <OrderId>String</OrderId>
    <PaymentMethod>
      <CVC>String</CVC>
      <ExpMonth>String</ExpMonth>
      <ExpYear>String</ExpYear>
      <PAN>String</PAN>
      <PaymentType>String</PaymentType>
      <Token>String</Token>
    </PaymentMethod>
    <SaveCardToToken>false</SaveCardToToken>
    <TransActionDate>0001-01-01T00:00:00</TransActionDate>
  </CardInfo>
  <DeviceId>String</DeviceId>
  <DiscountCode>String</DiscountCode>
  <DonationAmount>0</DonationAmount>
  <HolderEmail>String</HolderEmail>
  <HolderId>String</HolderId>
  <HolderName>String</HolderName>
  <IdempotencyKey>String</IdempotencyKey>
  <IsSubscription>false</IsSubscription>
  <OwnerCardTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </OwnerCardTypeIds>
  <PaymentMethodId>String</PaymentMethodId>
  <PaymentPhoneNumber>String</PaymentPhoneNumber>
  <PhoneVerificationNumber>String</PhoneVerificationNumber>
  <RequestUnixUTCTimeStamp>0</RequestUnixUTCTimeStamp>
  <ReturnCards>false</ReturnCards>
  <Signature>
    <Signature>String</Signature>
    <SystemId>String</SystemId>
    <SystemSecret>String</SystemSecret>
  </Signature>
  <Tenders>
    <OrderTender>
      <AmountMinor>0</AmountMinor>
      <AppliedMinor>0</AppliedMinor>
      <Code>String</Code>
      <HoldId>0</HoldId>
      <IdempotencyKey>String</IdempotencyKey>
      <Kind>String</Kind>
    </OrderTender>
  </Tenders>
</OwnerCardsOrderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OwnerCardsOrderResult 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>
</OwnerCardsOrderResult>