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
GiftCardPurchaseRequest Parameters:
NameParameterData TypeRequiredDescription
GiftCardTypeIdbodyintNo
AmountMinorbodyintNo
PurchasePaymentReferencebodystringNo
PurchaseOwnerIdbodyint?No
BuyerNamebodystringNo
BuyerPhonebodystringNo
BuyerEmailbodystringNo
RecipientNamebodystringNo
IdempotencyKeybodystringNo
PaymentMethodIdbodystringNo
PaymentIdbodystringNo
CardInfobodyPaymentRequestCreditCardNo
Borgun3DFinalInfobodyBorgun3DFinalRequestNo
ApplePayInfobodyBorgunApplePayFinalInfoNo
PaymentRequestCreditCard Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodformPaymentMethodCreditCardInfoNo
AmountformdecimalNo
CurrencyformstringNo
OrderIdformstringNo
TransActionDateformDateTimeNo
SaveCardToTokenformboolNo
PaymentMethodCreditCardInfo Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
TokenformstringNo
PANformstringNo
ExpYearformstringNo
ExpMonthformstringNo
CVCformstringNo
Borgun3DFinalRequest Parameters:
NameParameterData TypeRequiredDescription
TransactionTypeformstringNo
AmountformintNo
CurrencyformstringNo
TransactionDateformDateTime?No
OrderIdformstringNo
PaymentMethodformBorgun3DFinalPaymentMethodInfoNo
ThreeDSecureformBorgun3DFinal3DSecureInfoNo
Borgun3DFinalPaymentMethodInfo Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
TokenformstringNo
VirtualNumberformstringNo
ExpYearformstringNo
ExpMonthformstringNo
PanLastFourformstringNo
Borgun3DFinal3DSecureInfo Parameters:
NameParameterData TypeRequiredDescription
DataTypeformstringNo
MpiTokenformstringNo
BorgunApplePayFinalInfo Parameters:
NameParameterData TypeRequiredDescription
OrderIdformstringNo
ThreeDSecureformBorgunApplePayThreeDSecureInfoNo
BorgunApplePayThreeDSecureInfo Parameters:
NameParameterData TypeRequiredDescription
DataTypeformstringNo
SecurityLevelIndformstringNo
CAVVformstringNo
UCAFformstringNo
GiftCardIssueResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
GiftCardIdformint?No
CodeformstringNo
CodeLast4formstringNo
StatusformstringNo
ExpiresAtformDateTime?No
PaymentIdformstringNo
StatusCodeformintNo
MessageformstringNo

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>