TicketUserServices

<back to all web services

GiftCardPurchaseRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Purchase
import Foundation
import ServiceStack

public class GiftCardPurchaseRequest : Codable
{
    public var giftCardTypeId:Int?
    public var amountMinor:Int?
    public var purchasePaymentReference:String?
    public var purchaseOwnerId:Int?
    public var buyerName:String?
    public var buyerPhone:String?
    public var buyerEmail:String?
    public var recipientName:String?
    public var idempotencyKey:String?
    public var paymentMethodId:String?
    public var paymentId:String?
    public var cardInfo:PaymentRequestCreditCard?
    public var borgun3DFinalInfo:Borgun3DFinalRequest?
    public var applePayInfo:BorgunApplePayFinalInfo?

    required public init(){}
}

public class PaymentRequestCreditCard : Codable
{
    public var paymentMethod:PaymentMethodCreditCardInfo?
    public var amount:Double?
    public var currency:String?
    public var orderId:String?
    public var transActionDate:Date?
    public var saveCardToToken:Bool?

    required public init(){}
}

public class PaymentMethodCreditCardInfo : Codable
{
    public var paymentType:String?
    public var token:String?
    public var pan:String?
    public var expYear:String?
    public var expMonth:String?
    public var cvc:String?

    required public init(){}
}

public class Borgun3DFinalRequest : Codable
{
    public var transactionType:String?
    public var amount:Int?
    public var currency:String?
    public var transactionDate:Date?
    public var orderId:String?
    public var paymentMethod:Borgun3DFinalPaymentMethodInfo?
    public var threeDSecure:Borgun3DFinal3DSecureInfo?

    required public init(){}
}

public class Borgun3DFinalPaymentMethodInfo : Codable
{
    public var paymentType:String?
    public var token:String?
    public var virtualNumber:String?
    public var expYear:String?
    public var expMonth:String?
    public var panLastFour:String?

    required public init(){}
}

public class Borgun3DFinal3DSecureInfo : Codable
{
    public var dataType:String?
    public var mpiToken:String?

    required public init(){}
}

public class BorgunApplePayFinalInfo : Codable
{
    public var orderId:String?
    public var threeDSecure:BorgunApplePayThreeDSecureInfo?

    required public init(){}
}

public class BorgunApplePayThreeDSecureInfo : Codable
{
    public var dataType:String?
    public var securityLevelInd:String?
    public var cavv:String?
    public var ucaf:String?

    required public init(){}
}

public class GiftCardIssueResult : Codable
{
    public var success:Bool?
    public var giftCardId:Int?
    public var code:String?
    public var codeLast4:String?
    public var status:String?
    public var expiresAt:Date?
    public var paymentId:String?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}


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

<GiftCardPurchaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AmountMinor>0</AmountMinor>
  <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>
  <BuyerEmail>String</BuyerEmail>
  <BuyerName>String</BuyerName>
  <BuyerPhone>String</BuyerPhone>
  <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>
  <GiftCardTypeId>0</GiftCardTypeId>
  <IdempotencyKey>String</IdempotencyKey>
  <PaymentId>String</PaymentId>
  <PaymentMethodId>String</PaymentMethodId>
  <PurchaseOwnerId>0</PurchaseOwnerId>
  <PurchasePaymentReference>String</PurchasePaymentReference>
  <RecipientName>String</RecipientName>
</GiftCardPurchaseRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardIssueResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Code>String</Code>
  <CodeLast4>String</CodeLast4>
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <GiftCardId>0</GiftCardId>
  <Message>String</Message>
  <PaymentId>String</PaymentId>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
  <Success>false</Success>
</GiftCardIssueResult>