ApexERPHost

<back to all web services

WsRegisterTransaction

Requires Authentication
The following routes are available for this service:
POST/POS/WissolCards/RegisterTransaction
WsRegisterTransaction Parameters:
NameParameterData TypeRequiredDescription
DatabodyWsRegisterTransactionReqNo
WsRegisterTransactionReq Parameters:
NameParameterData TypeRequiredDescription
agentTransactionIdformstringNo
sessionIdformlongNo
customerCardNumberformstringNo
callerformWsCallerNo
paymentformList<WsPayment>No
receiptformWsReceiptNo
agentTransactionDateTimeformstringNo
languageCodeformstringNo
businessDayformintNo
businessDayDateformstringNo
additionalDataformstringNo
WsCaller Parameters:
NameParameterData TypeRequiredDescription
branchformintNo
companyCodeformstringNo
companyTokenformstringNo
posCodeformstringNo
posDeviceCodeformstringNo
operatorIdformstringNo
WsPayment Parameters:
NameParameterData TypeRequiredDescription
acquirerIdformlongNo
approvalCodeformlongNo
amountformfloatNo
paymentTypeformWsPayTypeNo
timeStampformstringNo
cardCircuitformstringNo
cardPanformstringNo
expiryDateformstringNo
WsReceipt Parameters:
NameParameterData TypeRequiredDescription
productsformList<WsProduct>No
totalAmountformfloatNo
productDiscountAmountformfloatNo
basketDiscountAmountformfloatNo
giftDiscountAmountformfloatNo
WsProduct Parameters:
NameParameterData TypeRequiredDescription
productCodeformstringNo
productStatusformstringNo
quantityformfloatNo
priceformfloatNo
giftDiscountformfloatNo
discountformfloatNo
discountedPriceformfloatNo
WsRegisterTransactionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformWsRegisterTransactionRespNo
ErrorInfoformList<WsErrorInfo>No
WsRegisterTransactionResp Parameters:
NameParameterData TypeRequiredDescription
transactionIdformlongNo
sessionIdformlongNo
customerformWsCustomerNo
earnedPointsformfloatNo
earnedGiftsformstringNo
statusformstringNo
transactionErrorCauseListformList<string>No
requestformWsRegisterTransactionReqNo
WsCustomer Parameters:
NameParameterData TypeRequiredDescription
cardNumberformstringNo
nameformstringNo
clientStatusformstringNo
clientPhoneformstringNo
clientEMailformstringNo
cardStatusformstringNo
cardCategoryformstringNo
cardNameformstringNo
loyaltyPointsformfloatNo
loyaltyPointsAmountformfloatNo
activationDateformDateTime?No
expirationDateformDateTime?No
isSelectedformboolNo
WsErrorInfo Parameters:
NameParameterData TypeRequiredDescription
errorformstringNo
messageformstringNo
translatedMessageformstringNo
fieldformstringNo
otpKeyformstringNo

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 /POS/WissolCards/RegisterTransaction HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	{
		agentTransactionId: String,
		sessionId: 0,
		customerCardNumber: String,
		caller: 
		{
			branch: 0,
			companyCode: String,
			companyToken: String,
			posCode: String,
			posDeviceCode: String,
			operatorId: String
		},
		payment: 
		[
			{
				acquirerId: 0,
				approvalCode: 0,
				amount: 0,
				paymentType: CASH,
				timeStamp: String,
				cardCircuit: String,
				cardPan: String,
				expiryDate: String
			}
		],
		receipt: 
		{
			products: 
			[
				{
					productCode: String,
					productStatus: String,
					quantity: 0,
					price: 0,
					giftDiscount: 0,
					discount: 0,
					discountedPrice: 0
				}
			],
			totalAmount: 0,
			productDiscountAmount: 0,
			basketDiscountAmount: 0,
			giftDiscountAmount: 0
		},
		agentTransactionDateTime: String,
		languageCode: String,
		businessDay: 0,
		businessDayDate: String,
		additionalData: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	{
		transactionId: 0,
		sessionId: 0,
		customer: 
		{
			cardNumber: String,
			name: String,
			clientStatus: String,
			clientPhone: String,
			clientEMail: String,
			cardStatus: String,
			cardCategory: String,
			cardName: String,
			loyaltyPoints: 0,
			loyaltyPointsAmount: 0,
			activationDate: 0001-01-01,
			expirationDate: 0001-01-01,
			isSelected: False
		},
		earnedPoints: 0,
		earnedGifts: String,
		status: String,
		transactionErrorCauseList: 
		[
			String
		],
		request: 
		{
			agentTransactionId: String,
			sessionId: 0,
			customerCardNumber: String,
			caller: 
			{
				branch: 0,
				companyCode: String,
				companyToken: String,
				posCode: String,
				posDeviceCode: String,
				operatorId: String
			},
			payment: 
			[
				{
					acquirerId: 0,
					approvalCode: 0,
					amount: 0,
					paymentType: CASH,
					timeStamp: String,
					cardCircuit: String,
					cardPan: String,
					expiryDate: String
				}
			],
			receipt: 
			{
				products: 
				[
					{
						productCode: String,
						productStatus: String,
						quantity: 0,
						price: 0,
						giftDiscount: 0,
						discount: 0,
						discountedPrice: 0
					}
				],
				totalAmount: 0,
				productDiscountAmount: 0,
				basketDiscountAmount: 0,
				giftDiscountAmount: 0
			},
			agentTransactionDateTime: String,
			languageCode: String,
			businessDay: 0,
			businessDayDate: String,
			additionalData: String
		}
	},
	ErrorInfo: 
	[
		{
			error: String,
			message: String,
			translatedMessage: String,
			field: String,
			otpKey: String
		}
	]
}