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
PaymentCardsRequest Parameters:
NameParameterData TypeRequiredDescription
PhoneVerificationNumberbodystringNo
DeviceIdbodystringNo
OnlyForEventIdbodyint?No
CheckForExpirybodybool?No
ExcludeHiddenCardsbodybool?No
RequestUnixUTCTimeStampbodylongNo
IncludeDeletedCardsbodybool?No
SignaturebodyRequestSignatureNo
RequestSignature Parameters:
NameParameterData TypeRequiredDescription
SystemIdformstringNo
SystemSecretformstringNo
SignatureformstringNo
PaymentCardsResult Parameters:
NameParameterData TypeRequiredDescription
CardsformList<BorgunSavedCards>No
KsiCardsformList<KsiCards>No
OwnerCardsformList<OwnerCards>No
KsiCardInfoListformList<KsiCardInfo>No
OwnerCardInfoListformList<OwnerCardInfo>No
StatusCodeformintNo
MessageformstringNo
BorgunSavedCards Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CreationDateformDateTime?No
LastTokenDateformDateTime?No
isDebitformbool?No
PhoneVerificationNumberformstringNo
DeviceIdformstringNo
VirtualCardNumberformstringNo
PanLastFourformstringNo
ExpYearformstringNo
ExpMonthformstringNo
TokenformstringNo
CardTypeformstringNo
DeletedByUserformbool?No
DeletedFromOriginformbool?No
DateDeletedByUserformDateTime?No
DateDeletedFromOriginformDateTime?No
IsDeletedformbool?No
DateDeletedBySystemformDateTime?No
DeletedBySystemformbool?No
KsiCards Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CreationDateformDateTime?No
PhoneFullVerificationNumberformstringNo
DeviceIdformstringNo
KsiCardTypeIdformstringNo
KsiClubIdformstringNo
HolderNameformstringNo
CanTransferToPhoneFullNumberformstringNo
CanTransferToNNameformstringNo
ExpYearformstringNo
ExpMonthformstringNo
OwnerCards Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
OwnerIdformintNo
OwnerCardTypeIdformint?No
PhoneVerificationIdformint?No
InitialMaxTicketsformint?No
CurrentAvailableTicketsformint?No
TimeStampCreatedUTCformDateTime?No
TimeStampLastChangedUTCformDateTime?No
TimeStampBoughtUTCformDateTime?No
TimeStampOrderedUTCformDateTime?No
CardValidFromUTCformDateTime?No
CardValidToUTCformDateTime?No
HasStoreCreditformboolNo
CardPriceformdecimalNo
PricePaidformdecimalNo
InitialStoreCreditformdecimal?No
CurrentStoreCreditformdecimal?No
PhoneFullVerificationNumberformstringNo
HolderIdformstringNo
HolderNameformstringNo
HolderEmailformstringNo
CardPriceCurrencyformstringNo
PricePaidCurrencyformstringNo
DeviceIdformstringNo
PaymentMethodIdformstringNo
PaymentReferenceformstringNo
PhoneVerificationNumberformstringNo
PaymentPhoneNumberformstringNo
PaymentIdformstringNo
PaymentStatusformstringNo
PaymentTokenIdformstringNo
MaxTicketsPerEventformint?No
MultiplePaymentsIdformstringNo
ImageUrlformstringNo
BackgroundImageUrlformstringNo
KsiCardInfo Parameters:
NameParameterData TypeRequiredDescription
CardformKsiCardsNo
CardTypeformKsiCardTypesNo
KsiCardTypes Parameters:
NameParameterData TypeRequiredDescription
KsiCardTypeIdformstringNo
KsiCardTypeNameformstringNo
KsiCardTypeDescriptionformstringNo
CardTypeOwnerformstringNo
MaxTicketsPerEventformint?No
OwnerCardInfo Parameters:
NameParameterData TypeRequiredDescription
CardformOwnerCardsNo
CardTypeformOwnerCardTypeNo
OwnerNameformstringNo
OwnerCardType Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
OwnerIdformintNo
MaxTicketsformint?No
TimeStampCreatedUTCformDateTime?No
TimeStampLastChangedUTCformDateTime?No
SaleStartDateUTCformDateTime?No
SaleEndDateUTCformDateTime?No
ValidStartDateForNewCardsUTCformDateTime?No
ValidEndDateForNewCardsUTCformDateTime?No
HasStoreCreditformboolNo
IsActiveformboolNo
OnlyForTeamUseformbool?No
PriceformdecimalNo
InitialStoreCreditformdecimalNo
DescriptionformstringNo
NameformstringNo
ImageUrlformstringNo
CurrencyformstringNo
MaxTicketsPerEventformint?No
BackgroundImageUrlformstringNo
ValidForConnectedOwnersformbool?No
SuperOwnerIdformint?No

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
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"}