| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Required permission: | Tickets.Add |
| POST | /GiftCard/Purchase |
|---|
namespace TicketUserServices.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type GiftCardIssueResult() =
member val Success:Boolean = new Boolean() with get,set
member val GiftCardId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Code:String = null with get,set
member val CodeLast4:String = null with get,set
member val Status:String = null with get,set
member val ExpiresAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val PaymentId:String = null with get,set
member val StatusCode:Int32 = new Int32() with get,set
member val Message:String = null with get,set
[<AllowNullLiteral>]
type PaymentMethodCreditCardInfo() =
member val PaymentType:String = null with get,set
member val Token:String = null with get,set
member val PAN:String = null with get,set
member val ExpYear:String = null with get,set
member val ExpMonth:String = null with get,set
member val CVC:String = null with get,set
[<AllowNullLiteral>]
type PaymentRequestCreditCard() =
member val PaymentMethod:PaymentMethodCreditCardInfo = null with get,set
member val Amount:Decimal = new Decimal() with get,set
member val Currency:String = null with get,set
member val OrderId:String = null with get,set
member val TransActionDate:DateTime = new DateTime() with get,set
member val SaveCardToToken:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type Borgun3DFinalPaymentMethodInfo() =
member val PaymentType:String = null with get,set
member val Token:String = null with get,set
member val VirtualNumber:String = null with get,set
member val ExpYear:String = null with get,set
member val ExpMonth:String = null with get,set
member val PanLastFour:String = null with get,set
[<AllowNullLiteral>]
type Borgun3DFinal3DSecureInfo() =
member val DataType:String = null with get,set
member val MpiToken:String = null with get,set
[<AllowNullLiteral>]
type Borgun3DFinalRequest() =
member val TransactionType:String = null with get,set
member val Amount:Int32 = new Int32() with get,set
member val Currency:String = null with get,set
member val TransactionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val OrderId:String = null with get,set
member val PaymentMethod:Borgun3DFinalPaymentMethodInfo = null with get,set
member val ThreeDSecure:Borgun3DFinal3DSecureInfo = null with get,set
[<AllowNullLiteral>]
type BorgunApplePayThreeDSecureInfo() =
member val DataType:String = null with get,set
member val SecurityLevelInd:String = null with get,set
member val CAVV:String = null with get,set
member val UCAF:String = null with get,set
[<AllowNullLiteral>]
type BorgunApplePayFinalInfo() =
member val OrderId:String = null with get,set
member val ThreeDSecure:BorgunApplePayThreeDSecureInfo = null with get,set
[<AllowNullLiteral>]
type GiftCardPurchaseRequest() =
member val GiftCardTypeId:Int32 = new Int32() with get,set
member val AmountMinor:Int32 = new Int32() with get,set
member val PurchasePaymentReference:String = null with get,set
member val PurchaseOwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val BuyerName:String = null with get,set
member val BuyerPhone:String = null with get,set
member val BuyerEmail:String = null with get,set
member val RecipientName:String = null with get,set
member val IdempotencyKey:String = null with get,set
member val PaymentMethodId:String = null with get,set
member val PaymentId:String = null with get,set
member val CardInfo:PaymentRequestCreditCard = null with get,set
member val Borgun3DFinalInfo:Borgun3DFinalRequest = null with get,set
member val ApplePayInfo:BorgunApplePayFinalInfo = null with get,set
F# GiftCardPurchaseRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>