TicketUserServices

<back to all web services

PaymentCardsRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
POST/paymentCardsGet All Credit, Debit and KSI cards for this phone

export class BorgunSavedCards
{
    public id?: number;
    public creationDate?: string;
    public lastTokenDate?: string;
    public isDebit?: boolean;
    public phoneVerificationNumber?: string;
    public deviceId?: string;
    public virtualCardNumber?: string;
    public panLastFour?: string;
    public expYear?: string;
    public expMonth?: string;
    public token?: string;
    public cardType?: string;
    public deletedByUser?: boolean;
    public deletedFromOrigin?: boolean;
    public dateDeletedByUser?: string;
    public dateDeletedFromOrigin?: string;
    public isDeleted?: boolean;
    public dateDeletedBySystem?: string;
    public deletedBySystem?: boolean;

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

export class KsiCards
{
    public id?: number;
    public creationDate?: string;
    public phoneFullVerificationNumber?: string;
    public deviceId?: string;
    public ksiCardTypeId?: string;
    public ksiClubId?: string;
    public holderName?: string;
    public canTransferToPhoneFullNumber?: string;
    public canTransferToNName?: string;
    public expYear?: string;
    public expMonth?: string;

    public constructor(init?: Partial<KsiCards>) { (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 constructor(init?: Partial<OwnerCards>) { (Object as any).assign(this, init); }
}

export class KsiCardTypes
{
    public ksiCardTypeId?: string;
    public ksiCardTypeName?: string;
    public ksiCardTypeDescription?: string;
    public cardTypeOwner?: string;
    public maxTicketsPerEvent?: number;

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

export class KsiCardInfo
{
    public card?: KsiCards;
    public cardType?: KsiCardTypes;

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

export class OwnerCardType
{
    public id?: number;
    public ownerId?: number;
    public maxTickets?: number;
    public timeStampCreatedUTC?: string;
    public timeStampLastChangedUTC?: string;
    public saleStartDateUTC?: string;
    public saleEndDateUTC?: string;
    public validStartDateForNewCardsUTC?: string;
    public validEndDateForNewCardsUTC?: string;
    public hasStoreCredit?: boolean;
    public isActive?: boolean;
    public onlyForTeamUse?: boolean;
    public price?: number;
    public initialStoreCredit?: number;
    public description?: string;
    public name?: string;
    public imageUrl?: string;
    public currency?: string;
    public maxTicketsPerEvent?: number;
    public backgroundImageUrl?: string;
    public validForConnectedOwners?: boolean;
    public superOwnerId?: number;

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

export class OwnerCardInfo
{
    public card?: OwnerCards;
    public cardType?: OwnerCardType;
    public ownerName?: string;

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

export class PaymentCardsResult
{
    public cards?: BorgunSavedCards[];
    public ksiCards?: KsiCards[];
    public ownerCards?: OwnerCards[];
    public ksiCardInfoList?: KsiCardInfo[];
    public ownerCardInfoList?: OwnerCardInfo[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<PaymentCardsResult>) { (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 PaymentCardsRequest
{
    public phoneVerificationNumber?: string;
    public deviceId?: string;
    public onlyForEventId?: number;
    public checkForExpiry?: boolean;
    public excludeHiddenCards?: boolean;
    public requestUnixUTCTimeStamp?: number;
    public includeDeletedCards?: boolean;
    public signature?: RequestSignature;

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

TypeScript PaymentCardsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /paymentCards HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"phoneVerificationNumber":"String","deviceId":"String","onlyForEventId":0,"checkForExpiry":false,"excludeHiddenCards":false,"requestUnixUTCTimeStamp":0,"includeDeletedCards":false,"signature":{"systemId":"String","systemSecret":"String","signature":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"cards":[{"id":0,"creationDate":"0001-01-01T00:00:00.0000000","lastTokenDate":"0001-01-01T00:00:00.0000000","isDebit":false,"phoneVerificationNumber":"String","deviceId":"String","virtualCardNumber":"String","panLastFour":"String","expYear":"String","expMonth":"String","token":"String","cardType":"String","deletedByUser":false,"deletedFromOrigin":false,"dateDeletedByUser":"0001-01-01T00:00:00.0000000","dateDeletedFromOrigin":"0001-01-01T00:00:00.0000000","isDeleted":false,"dateDeletedBySystem":"0001-01-01T00:00:00.0000000","deletedBySystem":false}],"ksiCards":[{"id":0,"creationDate":"0001-01-01T00:00:00.0000000","phoneFullVerificationNumber":"String","deviceId":"String","ksiCardTypeId":"String","ksiClubId":"String","holderName":"String","canTransferToPhoneFullNumber":"String","canTransferToNName":"String","expYear":"String","expMonth":"String"}],"ownerCards":[{"id":0,"ownerId":0,"ownerCardTypeId":0,"phoneVerificationId":0,"initialMaxTickets":0,"currentAvailableTickets":0,"timeStampCreatedUTC":"0001-01-01T00:00:00.0000000","timeStampLastChangedUTC":"0001-01-01T00:00:00.0000000","timeStampBoughtUTC":"0001-01-01T00:00:00.0000000","timeStampOrderedUTC":"0001-01-01T00:00:00.0000000","cardValidFromUTC":"0001-01-01T00:00:00.0000000","cardValidToUTC":"0001-01-01T00:00:00.0000000","hasStoreCredit":false,"cardPrice":0,"pricePaid":0,"initialStoreCredit":0,"currentStoreCredit":0,"phoneFullVerificationNumber":"String","holderId":"String","holderName":"String","holderEmail":"String","cardPriceCurrency":"String","pricePaidCurrency":"String","deviceId":"String","paymentMethodId":"String","paymentReference":"String","phoneVerificationNumber":"String","paymentPhoneNumber":"String","paymentId":"String","paymentStatus":"String","paymentTokenId":"String","maxTicketsPerEvent":0,"multiplePaymentsId":"String","imageUrl":"String","backgroundImageUrl":"String"}],"ksiCardInfoList":[{"card":{"id":0,"creationDate":"0001-01-01T00:00:00.0000000","phoneFullVerificationNumber":"String","deviceId":"String","ksiCardTypeId":"String","ksiClubId":"String","holderName":"String","canTransferToPhoneFullNumber":"String","canTransferToNName":"String","expYear":"String","expMonth":"String"},"cardType":{"ksiCardTypeId":"String","ksiCardTypeName":"String","ksiCardTypeDescription":"String","cardTypeOwner":"String","maxTicketsPerEvent":0}}],"ownerCardInfoList":[{"card":{"id":0,"ownerId":0,"ownerCardTypeId":0,"phoneVerificationId":0,"initialMaxTickets":0,"currentAvailableTickets":0,"timeStampCreatedUTC":"0001-01-01T00:00:00.0000000","timeStampLastChangedUTC":"0001-01-01T00:00:00.0000000","timeStampBoughtUTC":"0001-01-01T00:00:00.0000000","timeStampOrderedUTC":"0001-01-01T00:00:00.0000000","cardValidFromUTC":"0001-01-01T00:00:00.0000000","cardValidToUTC":"0001-01-01T00:00:00.0000000","hasStoreCredit":false,"cardPrice":0,"pricePaid":0,"initialStoreCredit":0,"currentStoreCredit":0,"phoneFullVerificationNumber":"String","holderId":"String","holderName":"String","holderEmail":"String","cardPriceCurrency":"String","pricePaidCurrency":"String","deviceId":"String","paymentMethodId":"String","paymentReference":"String","phoneVerificationNumber":"String","paymentPhoneNumber":"String","paymentId":"String","paymentStatus":"String","paymentTokenId":"String","maxTicketsPerEvent":0,"multiplePaymentsId":"String","imageUrl":"String","backgroundImageUrl":"String"},"cardType":{"id":0,"ownerId":0,"maxTickets":0,"timeStampCreatedUTC":"0001-01-01T00:00:00.0000000","timeStampLastChangedUTC":"0001-01-01T00:00:00.0000000","saleStartDateUTC":"0001-01-01T00:00:00.0000000","saleEndDateUTC":"0001-01-01T00:00:00.0000000","validStartDateForNewCardsUTC":"0001-01-01T00:00:00.0000000","validEndDateForNewCardsUTC":"0001-01-01T00:00:00.0000000","hasStoreCredit":false,"isActive":false,"onlyForTeamUse":false,"price":0,"initialStoreCredit":0,"description":"String","name":"String","imageUrl":"String","currency":"String","maxTicketsPerEvent":0,"backgroundImageUrl":"String","validForConnectedOwners":false,"superOwnerId":0},"ownerName":"String"}],"statusCode":0,"message":"String"}