Create order

v1.0.0

Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see or .

Note: For error handling and troubleshooting, see .

Input

{
  "type": "object",
  "properties": {
    "PayPal-Auth-Assertion": {
      "type": "string",
      "description": "Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header."
    },
    "PayPal-Client-Metadata-Id": {
      "type": "string",
      "description": "A Globally Unique Identifier (GUID) value."
    },
    "PayPal-Partner-Attribution-Id": {
      "type": "string"
    },
    "PayPal-Request-Id": {
      "type": "string"
    },
    "Prefer": {
      "type": "string"
    },
    "application_context": {
      "type": "object"
    },
    "intent": {
      "type": "string",
      "description": "The intent to either capture payment immediately or authorize a payment for an order after order creation.",
      "enum": [
        "CAPTURE",
        "AUTHORIZE"
      ]
    },
    "payer": {
      "type": "object"
    },
    "payment_source": {
      "type": "object",
      "description": "The payment source definition.",
      "properties": {
        "apple_pay": {
          "type": "object"
        },
        "bancontact": {
          "type": "object"
        },
        "blik": {
          "type": "object"
        },
        "card": {
          "type": "object",
          "description": "The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href=\"https://www.pcisecuritystandards.org/pci_security/completing_self_assessment\"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href=\"https://developer.paypal.com/docs/checkout/advanced/integrate/\">this Integration Guide</a>*.</blockquote>"
        },
        "crypto": {
          "type": "object"
        },
        "eps": {
          "type": "object"
        },
        "giropay": {
          "type": "object"
        },
        "google_pay": {
          "type": "object"
        },
        "ideal": {
          "type": "object"
        },
        "mybank": {
          "type": "object"
        },
        "p24": {
          "type": "object"
        },
        "paypal": {
          "type": "object"
        },
        "sofort": {
          "type": "object"
        },
        "token": {
          "type": "object",
          "description": "The tokenized payment source to fund a payment.",
          "required": [
            "id",
            "type"
          ],
          "properties": {
            "id": {
              "type": "string",
              "description": "The PayPal-generated ID for the token."
            },
            "type": {
              "type": "string",
              "description": "The tokenization method that generated the ID.",
              "enum": [
                "BILLING_AGREEMENT"
              ]
            }
          }
        },
        "trustly": {
          "type": "object"
        },
        "venmo": {
          "type": "object"
        }
      }
    },
    "purchase_units": {
      "type": "array",
      "description": "An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "intent",
    "purchase_units"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "The order details."
}