Order

The order details.

Structure

Order

Fields

Name	Type	Tags	Description	Getter	Setter
CreateTime	String	Optional	The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$	String getCreateTime()	setCreateTime(String createTime)
UpdateTime	String	Optional	The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$	String getUpdateTime()	setUpdateTime(String updateTime)
Id	String	Optional, Read-only	The ID of the order.	String getId()	setId(String id)
PaymentSource	PaymentSourceResponse	Optional	The payment source used to fund the payment.	PaymentSourceResponse getPaymentSource()	setPaymentSource(PaymentSourceResponse paymentSource)
Intent	CheckoutPaymentIntent	Optional	The intent to either capture payment immediately or authorize a payment for an order after order creation.	CheckoutPaymentIntent getIntent()	setIntent(CheckoutPaymentIntent intent)
ProcessingInstruction	ProcessingInstruction	Optional	The instruction to process an order.	ProcessingInstruction getProcessingInstruction()	setProcessingInstruction(ProcessingInstruction processingInstruction)
Payer	Payer	Optional	DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the payment_source.paypal object. In order to make this design more clear, the details in the payer object are now available under payment_source.paypal. Please use payment_source.paypal.	Payer getPayer()	setPayer(Payer payer)
PurchaseUnits	List<PurchaseUnit>	Optional	An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant. Constraints: Minimum Items: 1, Maximum Items: 10	List getPurchaseUnits()	setPurchaseUnits(List purchaseUnits)
Status	OrderStatus	Optional	The order status. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	OrderStatus getStatus()	setStatus(OrderStatus status)
Links	List<LinkDescription>	Optional, Read-only	An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.	List getLinks()	setLinks(List links)

Example (as JSON)

{
  "create_time": "create_time8",
  "update_time": "update_time4",
  "id": "id2",
  "payment_source": {
    "card": {
      "name": "name6",
      "last_digits": "last_digits0",
      "brand": "CB_NATIONALE",
      "available_networks": [
        "DELTA"
      ],
      "type": "UNKNOWN"
    },
    "paypal": {
      "email_address": "email_address0",
      "account_id": "account_id4",
      "account_status": "VERIFIED",
      "name": {
        "given_name": "given_name2",
        "surname": "surname8"
      },
      "phone_type": "FAX"
    },
    "bancontact": {
      "name": "name0",
      "country_code": "country_code0",
      "bic": "bic2",
      "iban_last_chars": "iban_last_chars8",
      "card_last_digits": "card_last_digits4"
    },
    "blik": {
      "name": "name2",
      "country_code": "country_code2",
      "email": "email4",
      "one_click": {
        "consumer_reference": "consumer_reference2"
      }
    },
    "eps": {
      "name": "name6",
      "country_code": "country_code6",
      "bic": "bic8"
    }
  },
  "intent": "CAPTURE"
}