Rsl.Lotteries

<back to all web services

PlaceOrder

PlaceOrder Parameters:
NameParameterData TypeRequiredDescription
CustomerIdquerystringYes
ItemsqueryList<PlaceOrderLineItem>YesThe list of order items, their product id and their quantity. There must be at least one item.
PaymentMethodqueryPaymentMethodType?NoThe 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
PaymentMethodNoncequerystringNoOnly provide one of the following payment identifiers: nonce, token or funding source id
PaymentMethodTokenquerystringNoOnly provide one of the following payment identifiers: nonce, token or funding source id
FundingSourceIdquerystringNoOnly provide one of the following payment identifiers: nonce, token or funding source id
SetAsDefaultPaymentqueryboolNoTrue to set the payment as the new default payment of the customer. Not supported for Cash, Cheque and MoneyOrder
RememberPaymentMethodquerybool?NoFalse to save payment method as disabled otherwise save as normal payment method in Dynamics
ChequequeryChequeNoCheque information is required only for Cheque payment method
CardholderNamequerystringNoCardholder name when saving the payment method and using a credit card nonce
PaymentDatequeryDateTime?NoPayment date is only supported for Cash, Cheque and Money Order. It must not be in the future or older than 30 days.
SubscriptionqueryPlaceOrderSubscriptionInfoNoSubscription info when creating a subscription as part of the order. Not supported for Cash, Cheque and MoneyOrder
GiftContactqueryAddGiftContactNoGift recipient for the order is optional but requires at least a first name, last name and address when provided.
SkipPreOrderConfirmationquerybool?NoSend pre-order confirmation mail/email if true.
RequestReferencequeryRequestReferenceYes
PlaceOrderLineItem Parameters:
NameParameterData TypeRequiredDescription
ProductIdformstringNo
QuantityformintNo
IsPreOrderformboolNo
OriginalItemIdformstringNo
PaymentMethodType Enum:
Cash
Cheque
MoneyOrder
CreditCard
PayPal
DirectDebit
Wallet
GooglePay
ApplePay
Cheque Parameters:
NameParameterData TypeRequiredDescription
BSBformstringNo
AccountNumberformstringNo
ChequeNumberformstringNo
PlaceOrderSubscriptionInfo Parameters:
NameParameterData TypeRequiredDescription
SubscriptionOpenFromLotteryformstringNo
PlanformstringNo
StartFromLotteryformstringNo
SubscriptionIdformstringNo
StartDateformDateTime?No
AddGiftContact Parameters:
NameParameterData TypeRequiredDescription
GiftContactIdformstringNo
TitleformPersonTitle?NoPerson title

Allowable Values

  • Mr
  • Mrs
  • Miss
  • Ms
  • Dr
FirstNameformstringNo
LastNameformstringNo
HomePhoneformstringNo
MobilePhoneformstringNo
MessageformstringNo
AddressformAddressNo
EmailformstringNo
PersonTitle Enum:
Mr
Mrs
Miss
Ms
Dr
Address Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
CityformstringNo
ZipCodeformstringNo
StateformstringNo
CountryRegionIdformstringNo
DPIDformintNo
SuburbformstringNo
RequestReference Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformstringNo
RetailChannelIdformstringYes
ReferenceIdformstringNo
PlaceOrderResponse Parameters:
NameParameterData TypeRequiredDescription
OrderTransactionIdformstringNo
PaymentResultformPaymentResultNo
ResponseStatusformResponseStatusNo
PaymentResult Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTime?No
ReferenceNumberformstringNoThe payment reference number
AmountformdecimalNoThe payment amount
TransactionIdformstringNoThe payment transaction identifier
TransactionStatusformstringNoOne of the transactions statuses in https://developers.braintreepayments.com/reference/general/statuses
ProcessorResponseCodeformstringNoOne of the codes in https://developers.braintreepayments.com/reference/general/processor-responses/authorization-responses
ProcessorResponseTextformstringNoThe text that describes the processor response
GatewayRejectionReasonformstringNoThe gateway rejection reason if any https://articles.braintreepayments.com/control-panel/transactions/gateway-rejections
CreditCardformCreditCardNoInformation about the used credit card for a credit card payment
PayPalDetailsformPayPalDetailsNoInformation about the paypal transaction for a paypal payment
PaymentMethodformPaymentMethodTypeNo
IsSuccessformbool?NoWhether the payment was successful.
CreditCard Parameters:
NameParameterData TypeRequiredDescription
CreditCardIdformstringNo
CardTokenformstringNo
TokenformstringNo
CardholderNameformstringNo
CardTypeformCreditCardTypeNo
UniqueNumberIdentifierformstringNo
ExpirationMonthformstringNo
ExpirationYearformstringNo
BinformstringNo
LastFourformstringNoThe last 4 digits of the credit card number
IsDefaultformboolNo
DisabledformboolNo
LastModifiedformDateTimeNo
CreditCardType Enum:
Unknown
AmericanExpress
CarteBlanche
ChinaUnionPay
DinersClub
Discover
JCB
Laser
Maestro
MasterCard
Solo
Switch
Visa
PayPalDetails Parameters:
NameParameterData TypeRequiredDescription
RefundIdformstringNo
CaptureIdformstringNo
SellerProtectionStatusformstringNo
PayerStatusformstringNo
PayerLastNameformstringNo
PayerFirstNameformstringNo
PayerIdformstringNo
PayeeEmailformstringNo
TokenformstringNo
AuthorizationIdformstringNo
PaymentIdformstringNo
PayerEmailformstringNo
TransactionFeeAmountformdecimalNo
TransactionFeeCurrencyIsoCodeformstringNo
DescriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/PlaceOrder HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: application/json
Content-Type: application/json
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-01T00:00:00.0000000","subscription":{"subscriptionOpenFromLottery":"String","plan":"String","startFromLottery":"String","subscriptionId":"String","startDate":"0001-01-01T00:00:00.0000000"},"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: application/json
Content-Length: length

{"orderTransactionId":"String","paymentResult":{"createdDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000"},"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"}}}