| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderTransactionId | path | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderTransactionId | form | string | No | |
| CustomerId | form | string | No | |
| Total | form | decimal | No | |
| State | form | OrderTransactionState | No | |
| PaymentResult | form | PaymentResult | No | |
| ErrorMessage | form | string | No | |
| Order | form | Order | No | |
| PreOrder | form | Order | No | |
| SubscriptionId | form | string | No | |
| InProgress | form | bool | No |
| Unknown |
| PendingOrder |
| PendingPayment |
| FailedOrder |
| FailedPayment |
| Complete |
| 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. |
| 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 |
| Unknown |
| AmericanExpress |
| CarteBlanche |
| ChinaUnionPay |
| DinersClub |
| Discover |
| JCB |
| Laser |
| Maestro |
| MasterCard |
| Solo |
| Switch |
| Visa |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Cash |
| Cheque |
| MoneyOrder |
| CreditCard |
| PayPal |
| DirectDebit |
| Wallet |
| GooglePay |
| ApplePay |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReceiptNumber | form | string | No | |
| OrderId | form | string | No | The order number |
| CreatedDate | form | DateTime? | No | |
| LastModified | form | DateTime? | No | |
| CustomerId | form | string | No | |
| Items | form | List<OrderLineItem> | No | |
| Status | form | OrderStatus? | No | |
| Total | form | decimal | No | |
| CampaignId | form | string | No | The campaign identifier associated to the order |
| GiftRecipient | form | Contact | No | The order gift recipient |
| GiftMessage | form | string | No | |
| IsGift | form | bool | No | |
| RewardType | form | RewardType? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ArtUnion | form | string | No | |
| ProductId | form | string | No | |
| LineItemId | form | string | No | |
| InventTransId | form | string | No | |
| ProductName | form | string | No | |
| ProductTicketCount | form | int? | No | |
| Quantity | form | int | No | |
| SubTotal | form | decimal | No | |
| TicketNumbers | form | string | No | |
| DrawDate | form | DateTime? | No | |
| GameType | form | string | No | |
| ArtUnionDictionary | form | Dictionary<string, string> | No | |
| ArtUnionStatus | form | ArtUnionStatus? | No | |
| LineItemStatus | form | OrderLineItemStatus? | No | |
| IsRefunded | form | bool? | No | |
| ArtUnionId | form | string | No | |
| IsVIPDraw | form | bool | No |
| Name | Value |
|---|---|
| Draft | 1 |
| Approved | 2 |
| PreOrder | 3 |
| Open | 4 |
| Closed | 5 |
| Batching | 6 |
| Sellout | 7 |
| Name | Value |
|---|---|
| Open | 1 |
| Closed | 2 |
| PreOrder | 3 |
| Name | Value |
|---|---|
| Unknown | 0 |
| Open | 1 |
| Invoiced | 4 |
| Cancelled | 5 |
| Pending | 6 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | form | string | No | |
| Title | form | PersonTitle? | No | Person titleAllowable Values
|
| FirstName | form | string | No | |
| LastName | form | string | No | |
| DateOfBirth | form | DateTime? | No | |
| HomePhone | form | string | No | |
| MobilePhone | form | string | No | |
| form | string | No | ||
| Address | form | Address | No |
| Mr |
| Mrs |
| Miss |
| Ms |
| Dr |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| 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
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}