TicketUserServices

GiftCardPurchaseRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin, MobileApp	Required 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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	giftCardTypeId: 0,
	amountMinor: 0,
	purchasePaymentReference: String,
	purchaseOwnerId: 0,
	buyerName: String,
	buyerPhone: String,
	buyerEmail: String,
	recipientName: String,
	idempotencyKey: String,
	paymentMethodId: String,
	paymentId: String,
	cardInfo: 
	{
		paymentMethod: 
		{
			paymentType: String,
			token: String,
			pan: String,
			expYear: String,
			expMonth: String,
			cvc: String
		},
		amount: 0,
		currency: String,
		orderId: String,
		transActionDate: 0001-01-01,
		saveCardToToken: False
	},
	borgun3DFinalInfo: 
	{
		transactionType: String,
		amount: 0,
		currency: String,
		transactionDate: 0001-01-01,
		orderId: String,
		paymentMethod: 
		{
			paymentType: String,
			token: String,
			virtualNumber: String,
			expYear: String,
			expMonth: String,
			panLastFour: String
		},
		threeDSecure: 
		{
			dataType: String,
			mpiToken: String
		}
	},
	applePayInfo: 
	{
		orderId: String,
		threeDSecure: 
		{
			dataType: String,
			securityLevelInd: String,
			cavv: String,
			ucaf: String
		}
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	giftCardId: 0,
	code: String,
	codeLast4: String,
	status: String,
	expiresAt: 0001-01-01,
	paymentId: String,
	statusCode: 0,
	message: String
}