| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Required permission: | Tickets.Add |
| POST | /GiftCard/Purchase |
|---|
export class GiftCardIssueResult
{
public success?: boolean;
public giftCardId?: number;
public code?: string;
public codeLast4?: string;
public status?: string;
public expiresAt?: string;
public paymentId?: string;
public statusCode?: number;
public message?: string;
public constructor(init?: Partial<GiftCardIssueResult>) { (Object as any).assign(this, init); }
}
export class PaymentMethodCreditCardInfo
{
public paymentType?: string;
public token?: string;
public pan?: string;
public expYear?: string;
public expMonth?: string;
public cvc?: string;
public constructor(init?: Partial<PaymentMethodCreditCardInfo>) { (Object as any).assign(this, init); }
}
export class PaymentRequestCreditCard
{
public paymentMethod?: PaymentMethodCreditCardInfo;
public amount?: number;
public currency?: string;
public orderId?: string;
public transActionDate?: string;
public saveCardToToken?: boolean;
public constructor(init?: Partial<PaymentRequestCreditCard>) { (Object as any).assign(this, init); }
}
export class Borgun3DFinalPaymentMethodInfo
{
public paymentType?: string;
public token?: string;
public virtualNumber?: string;
public expYear?: string;
public expMonth?: string;
public panLastFour?: string;
public constructor(init?: Partial<Borgun3DFinalPaymentMethodInfo>) { (Object as any).assign(this, init); }
}
export class Borgun3DFinal3DSecureInfo
{
public dataType?: string;
public mpiToken?: string;
public constructor(init?: Partial<Borgun3DFinal3DSecureInfo>) { (Object as any).assign(this, init); }
}
export class Borgun3DFinalRequest
{
public transactionType?: string;
public amount?: number;
public currency?: string;
public transactionDate?: string;
public orderId?: string;
public paymentMethod?: Borgun3DFinalPaymentMethodInfo;
public threeDSecure?: Borgun3DFinal3DSecureInfo;
public constructor(init?: Partial<Borgun3DFinalRequest>) { (Object as any).assign(this, init); }
}
export class BorgunApplePayThreeDSecureInfo
{
public dataType?: string;
public securityLevelInd?: string;
public cavv?: string;
public ucaf?: string;
public constructor(init?: Partial<BorgunApplePayThreeDSecureInfo>) { (Object as any).assign(this, init); }
}
export class BorgunApplePayFinalInfo
{
public orderId?: string;
public threeDSecure?: BorgunApplePayThreeDSecureInfo;
public constructor(init?: Partial<BorgunApplePayFinalInfo>) { (Object as any).assign(this, init); }
}
export class GiftCardPurchaseRequest
{
public giftCardTypeId?: number;
public amountMinor?: number;
public purchasePaymentReference?: string;
public purchaseOwnerId?: number;
public buyerName?: string;
public buyerPhone?: string;
public buyerEmail?: string;
public recipientName?: string;
public idempotencyKey?: string;
public paymentMethodId?: string;
public paymentId?: string;
public cardInfo?: PaymentRequestCreditCard;
public borgun3DFinalInfo?: Borgun3DFinalRequest;
public applePayInfo?: BorgunApplePayFinalInfo;
public constructor(init?: Partial<GiftCardPurchaseRequest>) { (Object as any).assign(this, init); }
}
TypeScript 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>