Rsl.Lotteries

UpdateOrderTransaction

Update an order transaction

The following routes are available for this service:
PATCH	/orders/transactions/{OrderTransactionId}

**UpdateOrderTransaction** Parameters:
Name	Parameter	Data Type	Required
OrderTransactionId	path	string	No
State	query	OrderTransactionState?	No
PaymentResult	query	PaymentResult	No
RemovePaymentResult	query	bool?	No
ErrorMessage	query	string	No
RemoveErrorMessage	query	bool?	No
SubscriptionId	query	string	No
FundingSourceId	query	string	No
GiftContactId	query	string	No
OrderId	query	string	No
OrderReceiptId	query	string	No
OrderCartId	query	string	No
PreOrderId	query	string	No
PreOrderReceiptId	query	string	No
PreOrderCartId	query	string	No
RemoveFundingSourceId	query	bool?	No
PaymentMethodNonce	query	string	No
RemovePaymentMethodNonce	query	bool?	No
PaymentMethodToken	query	string	No
RemovePaymentMethodToken	query	bool?	No
CardholderName	query	string	No
RemoveCardholderName	query	bool?	No
PaymentMethod	query	PaymentMethodType?	No
RemovePaymentMethod	query	bool?	No
AttemptToProcessOrder	query	int?	No
RetailOrderTransactionId	query	string	No
RetailPreOrderTransactionId	query	string	No

**OrderTransactionState** Enum:
Unknown
PendingOrder
PendingPayment
FailedOrder
FailedPayment
Complete

**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

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

**HttpResult** Parameters:
Name	Parameter	Data Type	Required
ResponseText	form	string	No
FileInfo	form	FileInfo	No
ContentType	form	string	No
Headers	form	Dictionary<string, string>	No
Cookies	form	List<Cookie>	No
ETag	form	string	No
Age	form	TimeSpan?	No
MaxAge	form	TimeSpan?	No
Expires	form	DateTime?	No
LastModified	form	DateTime?	No
CacheControl	form	CacheControl	No
ResultScope	form	Func<IDisposable>	No
AllowsPartialResponse	form	bool	No
Options	form	IDictionary<string, string>	No
Status	form	int	No
StatusCode	form	HttpStatusCode	No
StatusDescription	form	string	No
Response	form	Object	No
ResponseFilter	form	IContentTypeWriter	No
RequestContext	form	IRequest	No
View	form	string	No
Template	form	string	No
PaddingLength	form	int	No
IsPartialRequest	form	bool	No

**CacheControl** Enum:
Name	Value
None	0
Public	1
Private	2
MustRevalidate	4
NoCache	8
NoStore	16
NoTransform	32
ProxyRevalidate	64

**IRequest** Parameters:
Name	Parameter	Data Type	Required
OriginalRequest	form	Object	No
Response	form	IResponse	No
OperationName	form	string	No
Verb	form	string	No
RequestAttributes	form	RequestAttributes	No
RequestPreferences	form	IRequestPreferences	No
Dto	form	Object	No
ContentType	form	string	No
IsLocal	form	bool	No
UserAgent	form	string	No
Cookies	form	IDictionary<string, Cookie>	No
ResponseContentType	form	string	No
HasExplicitResponseContentType	form	bool	No
Items	form	Dictionary<string, Object>	No
Headers	form	NameValueCollection	No
QueryString	form	NameValueCollection	No
FormData	form	NameValueCollection	No
UseBufferedStream	form	bool	No
RawUrl	form	string	No
AbsoluteUri	form	string	No
UserHostAddress	form	string	No
RemoteIp	form	string	No
Authorization	form	string	No
IsSecureConnection	form	bool	No
AcceptTypes	form	string[]	No
PathInfo	form	string	No
OriginalPathInfo	form	string	No
ContentLength	form	long	No
Files	form	IHttpFile[]	No
UrlReferrer	form	Uri	No

**IResponse** Parameters:
Name	Parameter	Data Type	Required
OriginalResponse	form	Object	No
Request	form	IRequest	No
StatusCode	form	int	No
StatusDescription	form	string	No
ContentType	form	string	No
Dto	form	Object	No
UseBufferedStream	form	bool	No
IsClosed	form	bool	No
KeepAlive	form	bool	No
HasStarted	form	bool	No
Items	form	Dictionary<string, Object>	No

**RequestAttributes** Enum:
Name	Value
None	0
Localhost	1
LocalSubnet	2
External	4
Secure	8
InSecure	16
AnySecurityMode	24
HttpHead	32
HttpGet	64
HttpPost	128
HttpPut	256
HttpDelete	512
HttpPatch	1024
HttpOptions	2048
HttpOther	4096
AnyHttpMethod	8160
OneWay	8192
Reply	16384
AnyCallStyle	24576
Soap11	32768
Soap12	65536
Xml	131072
Json	262144
Jsv	524288
ProtoBuf	1048576
Csv	2097152
Html	4194304
Wire	8388608
MsgPack	16777216
FormatOther	33554432
AnyFormat	67076096
Http	67108864
MessageQueue	134217728
Tcp	268435456
Grpc	536870912
EndpointOther	1073741824
AnyEndpoint	2080374784
InProcess	-2147483648
InternalNetworkAccess	-2147483645
AnyNetworkAccessType	-2147483641
Any	-1

**IRequestPreferences** Parameters:
Name	Parameter	Data Type	Required	Description
AcceptsGzip	form	bool	No
AcceptsDeflate	form	bool	No

**IHttpFile** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
FileName	form	string	No
ContentLength	form	long	No
ContentType	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.

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

{
	orderTransactionId: String,
	state: Unknown,
	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
	},
	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/jsv
Content-Length: length

{
	
}