Rsl.Lotteries

PlaceOrder

**PlaceOrder** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	query	string	Yes
Items	query	List<PlaceOrderLineItem>	Yes	The list of order items, their product id and their quantity. There must be at least one item.
PaymentMethod	query	PaymentMethodType?	No	The payment method can be omitted when using a payment nonce or payment token. Otheriwse, it must be specified. Allowable Values Cash Cheque MoneyOrder CreditCard PayPal DirectDebit Wallet GooglePay ApplePay
PaymentMethodNonce	query	string	No	Only provide one of the following payment identifiers: nonce, token or funding source id
PaymentMethodToken	query	string	No	Only provide one of the following payment identifiers: nonce, token or funding source id
FundingSourceId	query	string	No	Only provide one of the following payment identifiers: nonce, token or funding source id
SetAsDefaultPayment	query	bool	No	True to set the payment as the new default payment of the customer. Not supported for Cash, Cheque and MoneyOrder
RememberPaymentMethod	query	bool?	No	False to save payment method as disabled otherwise save as normal payment method in Dynamics
Cheque	query	Cheque	No	Cheque information is required only for Cheque payment method
CardholderName	query	string	No	Cardholder name when saving the payment method and using a credit card nonce
PaymentDate	query	DateTime?	No	Payment date is only supported for Cash, Cheque and Money Order. It must not be in the future or older than 30 days.
Subscription	query	PlaceOrderSubscriptionInfo	No	Subscription info when creating a subscription as part of the order. Not supported for Cash, Cheque and MoneyOrder
GiftContact	query	AddGiftContact	No	Gift recipient for the order is optional but requires at least a first name, last name and address when provided.
SkipPreOrderConfirmation	query	bool?	No	Send pre-order confirmation mail/email if true.
RequestReference	query	RequestReference	Yes

**PlaceOrderLineItem** Parameters:
Name	Parameter	Data Type	Required
ProductId	form	string	No
Quantity	form	int	No
IsPreOrder	form	bool	No
OriginalItemId	form	string	No

**PaymentMethodType** Enum:
Cash
Cheque
MoneyOrder
CreditCard
PayPal
DirectDebit
Wallet
GooglePay
ApplePay

**Cheque** Parameters:
Name	Parameter	Data Type	Required
BSB	form	string	No
AccountNumber	form	string	No
ChequeNumber	form	string	No

**PlaceOrderSubscriptionInfo** Parameters:
Name	Parameter	Data Type	Required
SubscriptionOpenFromLottery	form	string	No
Plan	form	string	No
StartFromLottery	form	string	No
SubscriptionId	form	string	No
StartDate	form	DateTime?	No

**AddGiftContact** Parameters:
Name	Parameter	Data Type	Required	Description
GiftContactId	form	string	No
Title	form	PersonTitle?	No	Person title Allowable Values Mr Mrs Miss Ms Dr
FirstName	form	string	No
LastName	form	string	No
HomePhone	form	string	No
MobilePhone	form	string	No
Message	form	string	No
Address	form	Address	No
Email	form	string	No

**PersonTitle** Enum:
Mr
Mrs
Miss
Ms
Dr

**Address** Parameters:
Name	Parameter	Data Type	Required
Street	form	string	No
City	form	string	No
ZipCode	form	string	No
State	form	string	No
CountryRegionId	form	string	No
DPID	form	int	No
Suburb	form	string	No

**RequestReference** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	string	No
RetailChannelId	form	string	Yes
ReferenceId	form	string	No

**PlaceOrderResponse** Parameters:
Name	Parameter	Data Type	Required
OrderTransactionId	form	string	No
PaymentResult	form	PaymentResult	No
ResponseStatus	form	ResponseStatus	No

**PaymentResult** Parameters:
Name	Parameter	Data Type	Required	Description
CreatedDate	form	DateTime?	No
ReferenceNumber	form	string	No	The payment reference number
Amount	form	decimal	No	The payment amount
TransactionId	form	string	No	The payment transaction identifier
TransactionStatus	form	string	No	One of the transactions statuses in https://developers.braintreepayments.com/reference/general/statuses
ProcessorResponseCode	form	string	No	One of the codes in https://developers.braintreepayments.com/reference/general/processor-responses/authorization-responses
ProcessorResponseText	form	string	No	The text that describes the processor response
GatewayRejectionReason	form	string	No	The gateway rejection reason if any https://articles.braintreepayments.com/control-panel/transactions/gateway-rejections
CreditCard	form	CreditCard	No	Information about the used credit card for a credit card payment
PayPalDetails	form	PayPalDetails	No	Information about the paypal transaction for a paypal payment
PaymentMethod	form	PaymentMethodType	No
IsSuccess	form	bool?	No	Whether the payment was successful.

**CreditCard** Parameters:
Name	Parameter	Data Type	Required	Description
CreditCardId	form	string	No
CardToken	form	string	No
Token	form	string	No
CardholderName	form	string	No
CardType	form	CreditCardType	No
UniqueNumberIdentifier	form	string	No
ExpirationMonth	form	string	No
ExpirationYear	form	string	No
Bin	form	string	No
LastFour	form	string	No	The last 4 digits of the credit card number
IsDefault	form	bool	No
Disabled	form	bool	No
LastModified	form	DateTime	No

**CreditCardType** Enum:
Unknown
AmericanExpress
CarteBlanche
ChinaUnionPay
DinersClub
Discover
JCB
Laser
Maestro
MasterCard
Solo
Switch
Visa

**PayPalDetails** Parameters:
Name	Parameter	Data Type	Required
RefundId	form	string	No
CaptureId	form	string	No
SellerProtectionStatus	form	string	No
PayerStatus	form	string	No
PayerLastName	form	string	No
PayerFirstName	form	string	No
PayerId	form	string	No
PayeeEmail	form	string	No
Token	form	string	No
AuthorizationId	form	string	No
PaymentId	form	string	No
PayerEmail	form	string	No
TransactionFeeAmount	form	decimal	No
TransactionFeeCurrencyIsoCode	form	string	No
Description	form	string	No

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 /jsv/reply/PlaceOrder HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	customerId: String,
	items: 
	[
		{
			productId: String,
			quantity: 0,
			isPreOrder: False,
			originalItemId: String
		}
	],
	paymentMethod: Cash,
	paymentMethodNonce: String,
	paymentMethodToken: String,
	fundingSourceId: String,
	setAsDefaultPayment: False,
	rememberPaymentMethod: False,
	cheque: 
	{
		bsb: String,
		accountNumber: String,
		chequeNumber: String
	},
	cardholderName: String,
	paymentDate: 0001-01-01,
	subscription: 
	{
		subscriptionOpenFromLottery: String,
		plan: String,
		startFromLottery: String,
		subscriptionId: String,
		startDate: 0001-01-01
	},
	giftContact: 
	{
		giftContactId: String,
		title: Mr,
		firstName: String,
		lastName: String,
		homePhone: String,
		mobilePhone: String,
		message: String,
		address: 
		{
			street: String,
			city: String,
			zipCode: String,
			state: String,
			countryRegionId: String,
			dpid: 0,
			suburb: String
		},
		email: String
	},
	skipPreOrderConfirmation: False,
	requestReference: 
	{
		campaignId: String,
		retailChannelId: String,
		referenceId: String
	}
}

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

{
	orderTransactionId: String,
	paymentResult: 
	{
		createdDate: 0001-01-01,
		referenceNumber: String,
		amount: 0,
		transactionId: String,
		transactionStatus: String,
		processorResponseCode: String,
		processorResponseText: String,
		gatewayRejectionReason: String,
		creditCard: 
		{
			creditCardId: String,
			cardToken: String,
			token: String,
			cardholderName: String,
			cardType: Unknown,
			uniqueNumberIdentifier: String,
			expirationMonth: String,
			expirationYear: String,
			bin: String,
			lastFour: String,
			isDefault: False,
			disabled: False,
			lastModified: 0001-01-01
		},
		payPalDetails: 
		{
			refundId: String,
			captureId: String,
			sellerProtectionStatus: String,
			payerStatus: String,
			payerLastName: String,
			payerFirstName: String,
			payerId: String,
			payeeEmail: String,
			token: String,
			authorizationId: String,
			paymentId: String,
			payerEmail: String,
			transactionFeeAmount: 0,
			transactionFeeCurrencyIsoCode: String,
			description: String
		},
		paymentMethod: Cash,
		isSuccess: False
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}

Rsl.Lotteries

PlaceOrder

Allowable Values

Allowable Values

HTTP + JSV