Package com.softlayer.api.service.container.product.order

Class Receipt

  • @ApiType("SoftLayer_Container_Product_Order_Receipt")
public class Receipt
extends Entity
    When an order is placed (SoftLayer_Product_Order::placeOrder), a receipt is returned when the order is created successfully. The information in the receipt helps explain information about the order. It's order ID, and all the data within the order as well.

    For PayPal Orders, an URL is also returned to the user so that the user can complete the transaction. Users paying with PayPal must continue on to this URL, login and pay. When doing this, PayPal will redirect the user back to a SoftLayer page which will then "finalize" the authorization process. From here, Sales will verify the order by contacting the user in some way, unless sales has already spoken to the user about approving the order.

    For users paying with a credit card, a receipt means the order has gone to sales and is awaiting approval.
    See Also:
    SoftLayer_Container_Product_Order_Receipt

    • Field Detail

      • externalPaymentCheckoutUrl

        @ApiProperty(canBeNullOrNotSet=true)
protected String externalPaymentCheckoutUrl
        This URL refers to the location where you will visit to complete the payment authorization for an external service, such as PayPal. This property is associated with externalPaymentToken and will only be populated when purchasing products with an external service.

        Once you visit this location, you will be presented with the options to confirm payment or deny payment. If you confirm payment, you will be redirected back to the receipt for your order. If you deny, you will be redirected back to the cancel order page where you do not need to take any additional action.

        Until you confirm payment with the external service, your products will not be provisioned or accessible for your consumption. Upon successfully confirming payment, our system will be notified and the order approval and provisioning systems will begin processing. After provisioning is complete, your services will be available.

      • externalPaymentCheckoutUrlSpecified

        protected boolean externalPaymentCheckoutUrlSpecified

      • externalPaymentToken

        @ApiProperty(canBeNullOrNotSet=true)
protected String externalPaymentToken
        This token refers to the identifier for the external payment authorization. This token is associated with the externalPaymentCheckoutUrl and is only populated when purchasing products with an external service like PayPal.

      • externalPaymentTokenSpecified

        protected boolean externalPaymentTokenSpecified

      • orderDateSpecified

        protected boolean orderDateSpecified

      • orderDetails

        @ApiProperty(canBeNullOrNotSet=true)
protected Order orderDetails
        This is a copy of the order container (SoftLayer_Container_Product_Order) which holds all the data related to an order. This will only return when an order is processed successfully. It will contain all the items in an order as well as the order totals.

      • orderDetailsSpecified

        protected boolean orderDetailsSpecified

      • orderIdSpecified

        protected boolean orderIdSpecified

      • paypalCheckoutUrl

        @ApiProperty(canBeNullOrNotSet=true)
protected String paypalCheckoutUrl
        Deprecation notice: use externalPaymentCheckoutUrl instead of this property.

        This URL refers to the location where you will visit to complete the payment authorization for PayPal. This property is associated with paypalToken and will only be populated when purchasing products with PayPal.

        Once you visit PayPal's site, you will be presented with the options to confirm payment or deny payment. If you confirm payment, you will be redirected back to the receipt for your order. If you deny, you will be redirected back to the cancel order page where you do not need to take any additional action.

        Until you confirm payment with PayPal, your products will not be provisioned or accessible for your consumption. Upon successfully confirming payment, our system will be notified and the order approval and provisioning systems will begin processing. After provisioning is complete, your services will be available.

      • paypalCheckoutUrlSpecified

        protected boolean paypalCheckoutUrlSpecified

      • paypalToken

        @ApiProperty(canBeNullOrNotSet=true)
protected String paypalToken
        Deprecation notice: use externalPaymentToken instead of this property.

        This token refers to the identifier provided when payment is processed via PayPal. This token is associated with the paypalCheckoutUrl.

      • paypalTokenSpecified

        protected boolean paypalTokenSpecified

      • placedOrder

        @ApiProperty(canBeNullOrNotSet=true)
protected Order placedOrder
        This is a copy of the order that was successfully placed (SoftLayer_Billing_Order). This will only return when an order is processed successfully.

      • placedOrderSpecified

        protected boolean placedOrderSpecified

      • quote

        @ApiProperty(canBeNullOrNotSet=true)
protected Quote quote
        This is a copy of the quote container (SoftLayer_Billing_Order_Quote) which holds all the data related to a quote. This will only return when a quote is processed successfully.

      • quoteSpecified

        protected boolean quoteSpecified

    • Constructor Detail

      • Receipt

        public Receipt()

    • Method Detail

      • getExternalPaymentCheckoutUrl

        public String getExternalPaymentCheckoutUrl()

      • setExternalPaymentCheckoutUrl

        public void setExternalPaymentCheckoutUrl​(String externalPaymentCheckoutUrl)

      • isExternalPaymentCheckoutUrlSpecified

        public boolean isExternalPaymentCheckoutUrlSpecified()

      • unsetExternalPaymentCheckoutUrl

        public void unsetExternalPaymentCheckoutUrl()

      • getExternalPaymentToken

        public String getExternalPaymentToken()

      • setExternalPaymentToken

        public void setExternalPaymentToken​(String externalPaymentToken)

      • isExternalPaymentTokenSpecified

        public boolean isExternalPaymentTokenSpecified()

      • unsetExternalPaymentToken

        public void unsetExternalPaymentToken()

      • isOrderDateSpecified

        public boolean isOrderDateSpecified()

      • unsetOrderDate

        public void unsetOrderDate()

      • getOrderDetails

        public Order getOrderDetails()

      • setOrderDetails

        public void setOrderDetails​(Order orderDetails)

      • isOrderDetailsSpecified

        public boolean isOrderDetailsSpecified()

      • unsetOrderDetails

        public void unsetOrderDetails()

      • getOrderId

        public Long getOrderId()

      • setOrderId

        public void setOrderId​(Long orderId)

      • isOrderIdSpecified

        public boolean isOrderIdSpecified()

      • unsetOrderId

        public void unsetOrderId()

      • getPaypalCheckoutUrl

        public String getPaypalCheckoutUrl()

      • setPaypalCheckoutUrl

        public void setPaypalCheckoutUrl​(String paypalCheckoutUrl)

      • isPaypalCheckoutUrlSpecified

        public boolean isPaypalCheckoutUrlSpecified()

      • unsetPaypalCheckoutUrl

        public void unsetPaypalCheckoutUrl()

      • getPaypalToken

        public String getPaypalToken()

      • setPaypalToken

        public void setPaypalToken​(String paypalToken)

      • isPaypalTokenSpecified

        public boolean isPaypalTokenSpecified()

      • unsetPaypalToken

        public void unsetPaypalToken()

      • getPlacedOrder

        public Order getPlacedOrder()

      • setPlacedOrder

        public void setPlacedOrder​(Order placedOrder)

      • isPlacedOrderSpecified

        public boolean isPlacedOrderSpecified()

      • unsetPlacedOrder

        public void unsetPlacedOrder()

      • getQuote

        public Quote getQuote()

      • setQuote

        public void setQuote​(Quote quote)

      • isQuoteSpecified

        public boolean isQuoteSpecified()

      • unsetQuote

        public void unsetQuote()