Rsl.Lotteries

<back to all web services

UpdateOrderTransaction

Update an order transaction

The following routes are available for this service:
PATCH/orders/transactions/{OrderTransactionId}
UpdateOrderTransaction Parameters:
NameParameterData TypeRequiredDescription
OrderTransactionIdpathstringNo
StatequeryOrderTransactionState?No
PaymentResultqueryPaymentResultNo
RemovePaymentResultquerybool?No
ErrorMessagequerystringNo
RemoveErrorMessagequerybool?No
SubscriptionIdquerystringNo
FundingSourceIdquerystringNo
GiftContactIdquerystringNo
OrderIdquerystringNo
OrderReceiptIdquerystringNo
OrderCartIdquerystringNo
PreOrderIdquerystringNo
PreOrderReceiptIdquerystringNo
PreOrderCartIdquerystringNo
RemoveFundingSourceIdquerybool?No
PaymentMethodNoncequerystringNo
RemovePaymentMethodNoncequerybool?No
PaymentMethodTokenquerystringNo
RemovePaymentMethodTokenquerybool?No
CardholderNamequerystringNo
RemoveCardholderNamequerybool?No
PaymentMethodqueryPaymentMethodType?No
RemovePaymentMethodquerybool?No
AttemptToProcessOrderqueryint?No
RetailOrderTransactionIdquerystringNo
RetailPreOrderTransactionIdquerystringNo
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
HttpResult Parameters:
NameParameterData TypeRequiredDescription
ResponseTextformstringNo
FileInfoformFileInfoNo
ContentTypeformstringNo
HeadersformDictionary<string, string>No
CookiesformList<Cookie>No
ETagformstringNo
AgeformTimeSpan?No
MaxAgeformTimeSpan?No
ExpiresformDateTime?No
LastModifiedformDateTime?No
CacheControlformCacheControlNo
ResultScopeformFunc<IDisposable>No
AllowsPartialResponseformboolNo
OptionsformIDictionary<string, string>No
StatusformintNo
StatusCodeformHttpStatusCodeNo
StatusDescriptionformstringNo
ResponseformObjectNo
ResponseFilterformIContentTypeWriterNo
RequestContextformIRequestNo
ViewformstringNo
TemplateformstringNo
PaddingLengthformintNo
IsPartialRequestformboolNo
CacheControl Enum:
NameValue
None0
Public1
Private2
MustRevalidate4
NoCache8
NoStore16
NoTransform32
ProxyRevalidate64
IRequest Parameters:
NameParameterData TypeRequiredDescription
OriginalRequestformObjectNo
ResponseformIResponseNo
OperationNameformstringNo
VerbformstringNo
RequestAttributesformRequestAttributesNo
RequestPreferencesformIRequestPreferencesNo
DtoformObjectNo
ContentTypeformstringNo
IsLocalformboolNo
UserAgentformstringNo
CookiesformIDictionary<string, Cookie>No
ResponseContentTypeformstringNo
HasExplicitResponseContentTypeformboolNo
ItemsformDictionary<string, Object>No
HeadersformNameValueCollectionNo
QueryStringformNameValueCollectionNo
FormDataformNameValueCollectionNo
UseBufferedStreamformboolNo
RawUrlformstringNo
AbsoluteUriformstringNo
UserHostAddressformstringNo
RemoteIpformstringNo
AuthorizationformstringNo
IsSecureConnectionformboolNo
AcceptTypesformstring[]No
PathInfoformstringNo
OriginalPathInfoformstringNo
ContentLengthformlongNo
FilesformIHttpFile[]No
UrlReferrerformUriNo
IResponse Parameters:
NameParameterData TypeRequiredDescription
OriginalResponseformObjectNo
RequestformIRequestNo
StatusCodeformintNo
StatusDescriptionformstringNo
ContentTypeformstringNo
DtoformObjectNo
UseBufferedStreamformboolNo
IsClosedformboolNo
KeepAliveformboolNo
HasStartedformboolNo
ItemsformDictionary<string, Object>No
RequestAttributes Enum:
NameValue
None0
Localhost1
LocalSubnet2
External4
Secure8
InSecure16
AnySecurityMode24
HttpHead32
HttpGet64
HttpPost128
HttpPut256
HttpDelete512
HttpPatch1024
HttpOptions2048
HttpOther4096
AnyHttpMethod8160
OneWay8192
Reply16384
AnyCallStyle24576
Soap1132768
Soap1265536
Xml131072
Json262144
Jsv524288
ProtoBuf1048576
Csv2097152
Html4194304
Wire8388608
MsgPack16777216
FormatOther33554432
AnyFormat67076096
Http67108864
MessageQueue134217728
Tcp268435456
Grpc536870912
EndpointOther1073741824
AnyEndpoint2080374784
InProcess-2147483648
InternalNetworkAccess-2147483645
AnyNetworkAccessType-2147483641
Any-1
IRequestPreferences Parameters:
NameParameterData TypeRequiredDescription
AcceptsGzipformboolNo
AcceptsDeflateformboolNo
IHttpFile Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
FileNameformstringNo
ContentLengthformlongNo
ContentTypeformstringNo

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

HTTP + CSV

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

PATCH /orders/transactions/{OrderTransactionId} HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"orderTransactionId":"String","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},"removePaymentResult":false,"errorMessage":"String","removeErrorMessage":false,"subscriptionId":"String","fundingSourceId":"String","giftContactId":"String","orderId":"String","orderReceiptId":"String","orderCartId":"String","preOrderId":"String","preOrderReceiptId":"String","preOrderCartId":"String","removeFundingSourceId":false,"paymentMethodNonce":"String","removePaymentMethodNonce":false,"paymentMethodToken":"String","removePaymentMethodToken":false,"cardholderName":"String","removeCardholderName":false,"paymentMethod":"Cash","removePaymentMethod":false,"attemptToProcessOrder":0,"retailOrderTransactionId":"String","retailPreOrderTransactionId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}