PayPal-PHP-Server-SDK/doc/models/order.md

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})$	getCreateTime(): ?string	setCreateTime(?string createTime): void
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})$	getUpdateTime(): ?string	setUpdateTime(?string updateTime): void
id	?string	Optional	The ID of the order.	getId(): ?string	setId(?string id): void
paymentSource	?PaymentSourceResponse	Optional	The payment source used to fund the payment.	getPaymentSource(): ?PaymentSourceResponse	setPaymentSource(?PaymentSourceResponse paymentSource): void
intent	?string(CheckoutPaymentIntent)	Optional	The intent to either capture payment immediately or authorize a payment for an order after order creation.	getIntent(): ?string	setIntent(?string intent): void
processingInstruction	mixed	Optional	-	getProcessingInstruction():	setProcessingInstruction( processingInstruction): void
payer	?Payer	Optional	-	getPayer(): ?Payer	setPayer(?Payer payer): void
purchaseUnits	?(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	getPurchaseUnits(): ?array	setPurchaseUnits(?array purchaseUnits): void
status	?string(OrderStatus)	Optional	The order status. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	getStatus(): ?string	setStatus(?string status): void
links	?(LinkDescription[])	Optional	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.	getLinks(): ?array	setLinks(?array links): void

Example (as JSON)

{
  "create_time": "create_time8",
  "update_time": "update_time4",
  "id": "id2",
  "payment_source": {
    "card": {
      "name": "name6",
      "last_digits": "last_digits0",
      "brand": "RUPAY",
      "available_networks": [
        "SYNCHRONY"
      ],
      "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"
}