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 java.math.*
import java.util.*
import net.servicestack.client.*


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

open class PaymentRequestCreditCard
{
    var paymentMethod:PaymentMethodCreditCardInfo? = null
    var amount:BigDecimal? = null
    var currency:String? = null
    var orderId:String? = null
    var transActionDate:Date? = null
    var saveCardToToken:Boolean? = null
}

open class PaymentMethodCreditCardInfo
{
    var paymentType:String? = null
    var token:String? = null
    var pan:String? = null
    var expYear:String? = null
    var expMonth:String? = null
    var cvc:String? = null
}

open class Borgun3DFinalRequest
{
    var transactionType:String? = null
    var amount:Int? = null
    var currency:String? = null
    var transactionDate:Date? = null
    var orderId:String? = null
    var paymentMethod:Borgun3DFinalPaymentMethodInfo? = null
    var threeDSecure:Borgun3DFinal3DSecureInfo? = null
}

open class Borgun3DFinalPaymentMethodInfo
{
    var paymentType:String? = null
    var token:String? = null
    var virtualNumber:String? = null
    var expYear:String? = null
    var expMonth:String? = null
    var panLastFour:String? = null
}

open class Borgun3DFinal3DSecureInfo
{
    var dataType:String? = null
    var mpiToken:String? = null
}

open class BorgunApplePayFinalInfo
{
    var orderId:String? = null
    var threeDSecure:BorgunApplePayThreeDSecureInfo? = null
}

open class BorgunApplePayThreeDSecureInfo
{
    var dataType:String? = null
    var securityLevelInd:String? = null
    var cavv:String? = null
    var ucaf:String? = null
}

open class GiftCardIssueResult
{
    var success:Boolean? = null
    var giftCardId:Int? = null
    var code:String? = null
    var codeLast4:String? = null
    var status:String? = null
    var expiresAt:Date? = null
    var paymentId:String? = null
    var statusCode:Int? = null
    var message:String? = null
}

Kotlin 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>