ConfirmOrderReference
Confirms that the order reference is free of constraints and all required information has been set on the order reference.
Description
After the order reference is free of constraints and all required information has been set on the order reference, call the ConfirmOrderReference operation. After you call this operation, the order reference is set to the Open state and you can submit authorisations against the order reference.
After you successfully call this operation, you should call the GetOrderReferenceDetails operation to get the remaining buyer information like name and shipping address. Before an order reference is confirmed, only the City, StateOrRegion, PostalCode, and CountryCode elements are returned in the call to GetOrderReferenceDetails.
Note: You can submit authorisation requests only when an order reference is in the Open state.
This operation has a maximum request quota of 10 and a restore rate of one request every second in the production environment. It has a maximum request quota of two and a restore rate of one request every two seconds in the sandbox environment. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.
Request parameters
For more information about the request parameters that are required for all Amazon MWS operations, see Required request parameters in the Amazon MWS Developer Guide.
| Parameter name | Required | Type | Description |
| AmazonOrderReferenceId | Yes | xs:string |
The order reference identifier.
This value is retrieved from the Amazon Button widget after the buyer has successfully authenticated with Amazon. |
| SuccessUrl | Yes | xs:string | The buyer is redirected to this URL if the SCA is successful. |
| FailureUrl | Yes | xs:string | The buyer is redirected to this URL if the SCA is unsuccessful. |
| AuthorizationAmount | No | Price | The amount to authenticate during SCA completion. Use this parameter _only_ if you want to set a payment amount that is different than the OrderTotal provided in the SetOrderReferenceDetails operation call |
| ExpectImmediateAuthorization | No | xs:boolean | Set this flag to true if you trigger the first authorization "immediately" (that is, within 50 minutes) after confirmation of the OrderReferenceObject. If this value is set to true, the OrderReferenceObject will be closed automatically in case no authorization is triggered within the defined timespan. This will allow for automatically cleaning up transactions that are abandoned by the buyer in the last phase of checkout, for example if the buyer is unable to solve the MFA challenge and aborts the checkout. |
Response elements
This operation returns only the standard response elements.
Examples
Sample query request
POST /OffAmazonPayments/2013-01-01 HTTP/1.1
Content-Type: x-www-form-urlencoded
Host: mws-eu.amazonservices.com
User-Agent: <Your User Agent Header>
AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE
&Action=ConfirmOrderReference
&AmazonOrderReferenceId=P02-8406368-4434100
&ExpectImmediateAuthorization=true
&SuccessUrl=http://www.test.com?status=success
&FailureUrl=http://www.test.com?status=failure
&SellerId=YOUR_SELLER_ID_HERE
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2019-02-06T19:01:11Z
&Version=2013-01-01
&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE
Sample response
<ConfirmOrderReferenceResponse
xmlns="https://mws-eu.amazonservices.com/schema/OffAmazonPayments/2013-01-01">
<ResponseMetadata>
<RequestId>f42df4b1-8047-11df-8d5c-bf56a38ef3b4</RequestId>
</ResponseMetadata>
</ConfirmOrderReferenceResponse>