Create order

POST

/v2/checkout/orders

Creates an order.

Note: For error handling and troubleshooting, see Orders v2 errors.

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Header 参数

Content-Type

string

必需

The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.

示例值:

application/json

Prefer

string

必需

The preferred server response upon successful completion of the request. Value is:

return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
return=representation. The server returns a complete resource representation, including the current state of the resource.

示例值:

PayPal-Request-Id

string

必需

The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.

示例值:

Body 参数application/json

intent

string

必需

purchase_units

array [object {2}]

必需

items

array [object {4}]

可选

amount

object

可选

application_context

object

必需

return_url

string

必需

cancel_url

string

必需

示例

{
    "intent": "CAPTURE",
    "purchase_units": [
        {
            "items": [
                {
                    "name": "T-Shirt",
                    "description": "Green XL",
                    "quantity": "1",
                    "unit_amount": {
                        "currency_code": "USD",
                        "value": "100.00"
                    }
                }
            ],
            "amount": {
                "currency_code": "USD",
                "value": "100.00",
                "breakdown": {
                    "item_total": {
                        "currency_code": "USD",
                        "value": "100.00"
                    }
                }
            }
        }
    ],
    "application_context": {
        "return_url": "https://example.com/return",
        "cancel_url": "https://example.com/cancel"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-m.sandbox.paypal.com/v2/checkout/orders' \
--header 'Prefer: ' \
--header 'PayPal-Request-Id: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "intent": "CAPTURE",
    "purchase_units": [
        {
            "items": [
                {
                    "name": "T-Shirt",
                    "description": "Green XL",
                    "quantity": "1",
                    "unit_amount": {
                        "currency_code": "USD",
                        "value": "100.00"
                    }
                }
            ],
            "amount": {
                "currency_code": "USD",
                "value": "100.00",
                "breakdown": {
                    "item_total": {
                        "currency_code": "USD",
                        "value": "100.00"
                    }
                }
            }
        }
    ],
    "application_context": {
        "return_url": "https://example.com/return",
        "cancel_url": "https://example.com/cancel"
    }
}'

返回响应

🟢201201 - Create Order With Minimal Request

application/json

Body

string

必需

intent

string

必需

status

string

必需

purchase_units

array [object {3}]

必需

reference_id

string

可选

amount

object

可选

payee

object

可选

create_time

string

必需

links

array [object {3}]

必需

href

string

必需

rel

string

必需

method

string

必需

示例

{
    "id": "09H88704RC448263N",
    "intent": "CAPTURE",
    "status": "CREATED",
    "purchase_units": [
        {
            "reference_id": "default",
            "amount": {
                "currency_code": "USD",
                "value": "100.00"
            },
            "payee": {
                "email_address": "etondoze-facilitator@gmail.com",
                "merchant_id": "ER87FV8ER63HJ"
            }
        }
    ],
    "create_time": "2022-02-04T02:22:17Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v2/checkout/orders/09H88704RC448263N",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://www.sandbox.paypal.com/checkoutnow?token=09H88704RC448263N",
            "rel": "approve",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v2/checkout/orders/09H88704RC448263N",
            "rel": "update",
            "method": "PATCH"
        },
        {
            "href": "https://api.sandbox.paypal.com/v2/checkout/orders/09H88704RC448263N/capture",
            "rel": "capture",
            "method": "POST"
        }
    ]
}

🟢201201 - Create Order With Detailed Request

🟢201201 - Create Order With Detailed Response

🟠400400 Bad Request - Invalid Parameter Value

🟠400400 Bad Request - Missing Required Parameter

🟠401401 Unauthorized - Authentication Failure

🟠401401 Unauthorized - Invalid Token

🟠422422 Unprocessable Entity - Amount Value Exceeded

🟠422422 Unprocessable Entity - Invalid Currency Code

🟠422422 Unprocessable Entity - Item Total Mismatch

🟠422422 Unprocessable Entity - Payee Not Enabled For Card Processing

🟠429429 Too Many Requests - Blocked Due To Rate Limiting

修改于 2023-08-16 07:18:59

Generate client_token

Show order details