Class CheckoutResponse

java.lang.Object
io.deeplumen.ucp.models.schemas.shopping.CheckoutResponse

@Generated("jsonschema2pojo") public class CheckoutResponse extends Object
Checkout Response

Base checkout schema. Extensions compose onto this using allOf.

  • Constructor Details

    • CheckoutResponse

      public CheckoutResponse()
  • Method Details

    • getUcp

      public UCPCheckoutResponse getUcp()
      UCP Checkout Response

      UCP metadata for checkout responses. (Required)

    • setUcp

      public void setUcp(UCPCheckoutResponse ucp)
      UCP Checkout Response

      UCP metadata for checkout responses. (Required)

    • withUcp

      public CheckoutResponse withUcp(UCPCheckoutResponse ucp)
    • getId

      public String getId()
      Unique identifier of the checkout session. (Required)
    • setId

      public void setId(String id)
      Unique identifier of the checkout session. (Required)
    • withId

      public CheckoutResponse withId(String id)
    • getLineItems

      public List<LineItemResponse> getLineItems()
      List of line items being checked out. (Required)
    • setLineItems

      public void setLineItems(List<LineItemResponse> lineItems)
      List of line items being checked out. (Required)
    • withLineItems

      public CheckoutResponse withLineItems(List<LineItemResponse> lineItems)
    • getBuyer

      public Buyer getBuyer()
      Buyer

    • setBuyer

      public void setBuyer(Buyer buyer)
      Buyer

    • withBuyer

      public CheckoutResponse withBuyer(Buyer buyer)
    • getStatus

      public CheckoutResponse.Status getStatus()
      Checkout state indicating the current phase and required action. See Checkout Status lifecycle documentation for state transition details. (Required)
    • setStatus

      public void setStatus(CheckoutResponse.Status status)
      Checkout state indicating the current phase and required action. See Checkout Status lifecycle documentation for state transition details. (Required)
    • withStatus

      public CheckoutResponse withStatus(CheckoutResponse.Status status)
    • getCurrency

      public String getCurrency()
      ISO 4217 currency code. (Required)
    • setCurrency

      public void setCurrency(String currency)
      ISO 4217 currency code. (Required)
    • withCurrency

      public CheckoutResponse withCurrency(String currency)
    • getTotals

      public List<TotalResponse> getTotals()
      Different cart totals. (Required)
    • setTotals

      public void setTotals(List<TotalResponse> totals)
      Different cart totals. (Required)
    • withTotals

      public CheckoutResponse withTotals(List<TotalResponse> totals)
    • getMessages

      public List<Message> getMessages()
      List of messages with error and info about the checkout session state.
    • setMessages

      public void setMessages(List<Message> messages)
      List of messages with error and info about the checkout session state.
    • withMessages

      public CheckoutResponse withMessages(List<Message> messages)
    • getLinks

      public List<Link> getLinks()
      Links to be displayed by the platform (Privacy Policy, TOS). Mandatory for legal compliance. (Required)
    • setLinks

      public void setLinks(List<Link> links)
      Links to be displayed by the platform (Privacy Policy, TOS). Mandatory for legal compliance. (Required)
    • withLinks

      public CheckoutResponse withLinks(List<Link> links)
    • getExpiresAt

      public Date getExpiresAt()
      RFC 3339 expiry timestamp. Default TTL is 6 hours from creation if not sent.
    • setExpiresAt

      public void setExpiresAt(Date expiresAt)
      RFC 3339 expiry timestamp. Default TTL is 6 hours from creation if not sent.
    • withExpiresAt

      public CheckoutResponse withExpiresAt(Date expiresAt)
    • getContinueUrl

      public URI getContinueUrl()
      URL for checkout handoff and session recovery. MUST be provided when status is requires_escalation. See specification for format and availability requirements.
    • setContinueUrl

      public void setContinueUrl(URI continueUrl)
      URL for checkout handoff and session recovery. MUST be provided when status is requires_escalation. See specification for format and availability requirements.
    • withContinueUrl

      public CheckoutResponse withContinueUrl(URI continueUrl)
    • getPayment

      public PaymentResponse getPayment()
      Payment Response

      Payment configuration containing handlers. (Required)

    • setPayment

      public void setPayment(PaymentResponse payment)
      Payment Response

      Payment configuration containing handlers. (Required)

    • withPayment

      public CheckoutResponse withPayment(PaymentResponse payment)
    • getOrder

      public OrderConfirmation getOrder()
      Order Confirmation

      Order details available at the time of checkout completion.

    • setOrder

      public void setOrder(OrderConfirmation order)
      Order Confirmation

      Order details available at the time of checkout completion.

    • withOrder

      public CheckoutResponse withOrder(OrderConfirmation order)
    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
    • setAdditionalProperty

      public void setAdditionalProperty(String name, Object value)
    • withAdditionalProperty

      public CheckoutResponse withAdditionalProperty(String name, Object value)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object