Rsl.Lotteries

<back to all web services

GetOrderTransaction

GetOrderTransaction Parameters:
NameParameterData TypeRequiredDescription
OrderTransactionIdpathstringYes
OrderTransaction Parameters:
NameParameterData TypeRequiredDescription
OrderTransactionIdformstringNo
CustomerIdformstringNo
TotalformdecimalNo
StateformOrderTransactionStateNo
PaymentResultformPaymentResultNo
ErrorMessageformstringNo
OrderformOrderNo
PreOrderformOrderNo
SubscriptionIdformstringNo
InProgressformboolNo
OrderTransactionState Enum:
Unknown
PendingOrder
PendingPayment
FailedOrder
FailedPayment
Complete
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
PaymentMethodType Enum:
Cash
Cheque
MoneyOrder
CreditCard
PayPal
DirectDebit
Wallet
GooglePay
ApplePay
Order Parameters:
NameParameterData TypeRequiredDescription
ReceiptNumberformstringNo
OrderIdformstringNoThe order number
CreatedDateformDateTime?No
LastModifiedformDateTime?No
CustomerIdformstringNo
ItemsformList<OrderLineItem>No
StatusformOrderStatus?No
TotalformdecimalNo
CampaignIdformstringNoThe campaign identifier associated to the order
GiftRecipientformContactNoThe order gift recipient
GiftMessageformstringNo
IsGiftformboolNo
RewardTypeformRewardType?No
OrderLineItem Parameters:
NameParameterData TypeRequiredDescription
ArtUnionformstringNo
ProductIdformstringNo
LineItemIdformstringNo
InventTransIdformstringNo
ProductNameformstringNo
ProductTicketCountformint?No
QuantityformintNo
SubTotalformdecimalNo
TicketNumbersformstringNo
DrawDateformDateTime?No
GameTypeformstringNo
ArtUnionDictionaryformDictionary<string, string>No
ArtUnionStatusformArtUnionStatus?No
LineItemStatusformOrderLineItemStatus?No
IsRefundedformbool?No
ArtUnionIdformstringNo
IsVIPDrawformboolNo
ArtUnionStatus Enum:
NameValue
Draft1
Approved2
PreOrder3
Open4
Closed5
Batching6
Sellout7
OrderLineItemStatus Enum:
NameValue
Open1
Closed2
PreOrder3
OrderStatus Enum:
NameValue
Unknown0
Open1
Invoiced4
Cancelled5
Pending6
Contact Parameters:
NameParameterData TypeRequiredDescription
ContactIdformstringNo
TitleformPersonTitle?NoPerson title

Allowable Values

  • Mr
  • Mrs
  • Miss
  • Ms
  • Dr
FirstNameformstringNo
LastNameformstringNo
DateOfBirthformDateTime?No
HomePhoneformstringNo
MobilePhoneformstringNo
EmailformstringNo
AddressformAddressNo
PersonTitle Enum:
Mr
Mrs
Miss
Ms
Dr
Address Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
CityformstringNo
ZipCodeformstringNo
StateformstringNo
CountryRegionIdformstringNo
DPIDformintNo
SuburbformstringNo
RewardType Enum:
None
BonusTicket

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/GetOrderTransaction HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"orderTransactionId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"orderTransactionId":"String","customerId":"String","total":0,"state":"Unknown","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},"errorMessage":"String","order":{"receiptNumber":"String","orderId":"String","createdDate":"0001-01-01T00:00:00.0000000","lastModified":"0001-01-01T00:00:00.0000000","customerId":"String","items":[{"artUnion":"String","productId":"String","lineItemId":"String","inventTransId":"String","productName":"String","productTicketCount":0,"quantity":0,"subTotal":0,"ticketNumbers":"String","drawDate":"0001-01-01T00:00:00.0000000","gameType":"String","artUnionDictionary":{"String":"String"},"artUnionStatus":"0","lineItemStatus":"0","isRefunded":false,"artUnionId":"String","isVIPDraw":false}],"status":"Unknown","total":0,"campaignId":"String","giftRecipient":{"contactId":"String","title":"Mr","firstName":"String","lastName":"String","dateOfBirth":"0001-01-01T00:00:00.0000000","homePhone":"String","mobilePhone":"String","email":"String","address":{"street":"String","city":"String","zipCode":"String","state":"String","countryRegionId":"String","dpid":0,"suburb":"String"}},"giftMessage":"String","isGift":true,"rewardType":"None"},"preOrder":{"receiptNumber":"String","orderId":"String","createdDate":"0001-01-01T00:00:00.0000000","lastModified":"0001-01-01T00:00:00.0000000","customerId":"String","items":[{"artUnion":"String","productId":"String","lineItemId":"String","inventTransId":"String","productName":"String","productTicketCount":0,"quantity":0,"subTotal":0,"ticketNumbers":"String","drawDate":"0001-01-01T00:00:00.0000000","gameType":"String","artUnionDictionary":{"String":"String"},"artUnionStatus":"0","lineItemStatus":"0","isRefunded":false,"artUnionId":"String","isVIPDraw":false}],"status":"Unknown","total":0,"campaignId":"String","giftRecipient":{"contactId":"String","title":"Mr","firstName":"String","lastName":"String","dateOfBirth":"0001-01-01T00:00:00.0000000","homePhone":"String","mobilePhone":"String","email":"String","address":{"street":"String","city":"String","zipCode":"String","state":"String","countryRegionId":"String","dpid":0,"suburb":"String"}},"giftMessage":"String","isGift":true,"rewardType":"None"},"subscriptionId":"String","inProgress":false}