NetCard Server Web API

<back to all web services

PayShoppingCart

The following routes are available for this service:
POST/PrisonKiosk/PayShoppingCart/

To override the Content-type in your clients 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 /jsv/reply/PayShoppingCart HTTP/1.1 
Host: ncapi.net.au 
Content-Type: text/jsv
Content-Length: length

{
	ShoppingCart: 
	{
		MenuProducts: 
		[
			{
				ProductId: 0,
				SupplierId: 0,
				ManufacturerId: 0,
				Name: String,
				ShortDescription: String,
				StockCode: String,
				Note: String,
				Healthy: False,
				PicCode: String,
				Size: String,
				CustomerId: 0,
				UnitCost: 0,
				Cost: 0,
				RecommendedSalePrice: 0,
				PaidTax: 0,
				ProductImage: String,
				HealthFlagId: 0,
				StockRestriction: String,
				IsAdvertise: False,
				HealthFlag: 
				{
					HealthFlagId: 0,
					Name: String,
					Color: String
				}
			}
		],
		MenuProductCategories: 
		[
			{
				ProductCategoryId: 0,
				Name: String,
				Description: String
			}
		],
		CartItems: 
		[
			{
				CartItemId: 0,
				Product: 
				{
					ProductId: 0,
					SupplierId: 0,
					ManufacturerId: 0,
					Name: String,
					ShortDescription: String,
					StockCode: String,
					Note: String,
					Healthy: False,
					PicCode: String,
					Size: String,
					CustomerId: 0,
					UnitCost: 0,
					Cost: 0,
					RecommendedSalePrice: 0,
					PaidTax: 0,
					ProductImage: String,
					HealthFlagId: 0,
					StockRestriction: String,
					IsAdvertise: False,
					HealthFlag: 
					{
						HealthFlagId: 0,
						Name: String,
						Color: String
					}
				},
				Quantity: 0,
				TotalCartItemLinePrice: 0,
				MaxQuantity: 0,
				InventoryId: 0
			}
		],
		UserId: 0,
		AvailableFunds: 0,
		TotalPurchase: 0,
		DeviceId: 0,
		TransactionTypeId: 0,
		MessageLogId: String,
		CashDispensePay: 
		{
			CashDispenseId: 0,
			DeviceId: 0,
			CashDispenseTypeId: 0,
			UserId: 0,
			TransactionLogId: 0,
			Currency: String,
			CoinFiveCent: 0,
			CoinTenCent: 0,
			CoinTwentyCent: 0,
			CoinFiftyCent: 0,
			CoinOne: 0,
			CoinTwo: 0,
			NoteFive: 0,
			NoteTen: 0,
			NoteTwenty: 0,
			NoteFifty: 0,
			NoteOneHundred: 0,
			TotalCash: 0,
			DateIn: 0001-01-01,
			TotalCoin: 0,
			TotalNote: 0,
			CashKioskGenericAccount: 
			{
				AccountCode: String,
				UserAccountTypeId: 0
			},
			InvalidMoney: 
			{
				InvalidMoneyId: 0,
				BentCoinAmount: 0,
				RippedNoteAmount: 0,
				ChequeAmount: 0,
				TransactionLogId: 0,
				AssistingUserId: 0,
				TotalAmount: 0
			},
			CashDispenseQuantity: 
			{
				CashDispenseQuantityId: 0,
				CoinFiveCentQty: 0,
				CoinTenCentQty: 0,
				CoinTwentyCentQty: 0,
				CoinFiftyCentQty: 0,
				CoinOneQty: 0,
				CoinTwoQty: 0,
				NoteFiveQty: 0,
				NoteTenQty: 0,
				NoteTwentyQty: 0,
				NoteFiftyQty: 0,
				NoteOneHundredQty: 0
			},
			CashDispenserDeviceId: 0,
			TransactionLog: 
			{
				TransactionLogId: 0,
				PreviousTransactionLogId: 0,
				AccountCode: String,
				TransactionTypeId: 0,
				DeviceId: 0,
				TransactionAmount: 0,
				AmountAvailable: 0,
				Tax: 0,
				TransactionTime: 0001-01-01,
				AssistedUserId: 0,
				Options: String,
				UserAccountTypeId: 0,
				ReferenceNumber: String,
				OrderId: 0,
				CustomerId: 0,
				DepositTransferLogId: 0,
				DepositTransferLog: 
				{
					DepositTransferLogId: 0,
					UserId: 0,
					InmateId: 0,
					Amount: 0,
					CreatedDateTime: 0001-01-01,
					User: 
					{
						UserId: 0,
						Username: String,
						Password: String,
						IsActive: False,
						LastUpdated: 0001-01-01,
						Title: String,
						FirstName: String,
						LastName: String,
						UserGenderId: 0,
						Phone: String,
						Email: String,
						MailAddress: String,
						MemberId: String,
						CustomerId: 0,
						UserAccessTypeId: 0,
						DateOfBirth: 0001-01-01,
						Mobile: String,
						StreetNumber: String,
						City: String,
						State: String,
						LocationId: 0,
						ChildLocationId: 0,
						UserAccount: 
						{
							UserId: 0,
							UserAccountTypeId: 0,
							AccountCode: String,
							AccountPin: String,
							AmountAvailable: 0,
							LastUpdated: 0001-01-01,
							IsActive: False,
							RewardPoints: 0,
							LunchMoney: 0,
							Block: String,
							SpendingLimit: 0,
							AmountAvailable2: 0,
							DischargeAmount: 0,
							LunchMoneyStatus: 0,
							AmountDeposited: 0,
							CardNumber: String,
							ProfileImagePath: String,
							IncidentalInStatus: 0,
							ActivationDate: 0001-01-01,
							Note: String,
							CollectedLunchMoneyDate: 0001-01-01,
							NumberOfShopsBuy: 0,
							PinLockOutTimeUtc: 0001-01-01,
							PalmId: String
						},
						Location: 
						{
							LocationId: 0,
							Name: String,
							Description: String,
							CustomerId: 0,
							ParentLocationId: 0
						},
						LastLogin: 0001-01-01,
						GroupId: 0,
						IsProntoDown: False
					}
				}
			}
		}
	}
}
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
			}
		]
	},
	TransactionLog: 
	{
		TransactionLogId: 0,
		PreviousTransactionLogId: 0,
		AccountCode: String,
		TransactionTypeId: 0,
		DeviceId: 0,
		TransactionAmount: 0,
		AmountAvailable: 0,
		Tax: 0,
		TransactionTime: 0001-01-01,
		AssistedUserId: 0,
		Options: String,
		UserAccountTypeId: 0,
		ReferenceNumber: String,
		OrderId: 0,
		CustomerId: 0,
		DepositTransferLogId: 0,
		DepositTransferLog: 
		{
			DepositTransferLogId: 0,
			UserId: 0,
			InmateId: 0,
			Amount: 0,
			CreatedDateTime: 0001-01-01,
			User: 
			{
				UserId: 0,
				Username: String,
				Password: String,
				IsActive: False,
				LastUpdated: 0001-01-01,
				Title: String,
				FirstName: String,
				LastName: String,
				UserGenderId: 0,
				Phone: String,
				Email: String,
				MailAddress: String,
				MemberId: String,
				CustomerId: 0,
				UserAccessTypeId: 0,
				DateOfBirth: 0001-01-01,
				Mobile: String,
				StreetNumber: String,
				City: String,
				State: String,
				LocationId: 0,
				ChildLocationId: 0,
				UserAccount: 
				{
					UserId: 0,
					UserAccountTypeId: 0,
					AccountCode: String,
					AccountPin: String,
					AmountAvailable: 0,
					LastUpdated: 0001-01-01,
					IsActive: False,
					RewardPoints: 0,
					LunchMoney: 0,
					Block: String,
					SpendingLimit: 0,
					AmountAvailable2: 0,
					DischargeAmount: 0,
					LunchMoneyStatus: 0,
					AmountDeposited: 0,
					CardNumber: String,
					ProfileImagePath: String,
					IncidentalInStatus: 0,
					ActivationDate: 0001-01-01,
					Note: String,
					CollectedLunchMoneyDate: 0001-01-01,
					NumberOfShopsBuy: 0,
					PinLockOutTimeUtc: 0001-01-01,
					PalmId: String
				},
				Location: 
				{
					LocationId: 0,
					Name: String,
					Description: String,
					CustomerId: 0,
					ParentLocationId: 0
				},
				LastLogin: 0001-01-01,
				GroupId: 0,
				IsProntoDown: False
			}
		}
	},
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String
		}
	]
}