Capture payment for order

Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

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

请求参数

Authorization

在 Header 添加参数

Authorization

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

示例：

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

Path 参数

order_id

string

必需

示例值:

Header 参数

Content-Type

string

必需

示例值:

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

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢201201 - Capture Payment For Order

application/json

Body

string

必需

status

string

必需

purchase_units

array [object {3}]

必需

reference_id

string

可选

shipping

object

可选

payments

object

可选

payer

object

必需

name

object

必需

email_address

string

必需

payer_id

string

必需

address

object

必需

links

array [object {3}]

必需

href

string

可选

rel

string

可选

method

string

可选

示例

{
  "id": "24F22464WC842504J",
  "status": "COMPLETED",
  "purchase_units": [
    {
      "reference_id": "default",
      "shipping": {
        "name": {
          "full_name": "FooBuyer Jones"
        },
        "address": {
          "address_line_1": "1 Main St",
          "admin_area_2": "San Jose",
          "admin_area_1": "CA",
          "postal_code": "95131",
          "country_code": "US"
        }
      },
      "payments": {
        "captures": [
          {
            "id": "7KY78659SG487110K",
            "status": "COMPLETED",
            "amount": {
              "currency_code": "USD",
              "value": "100.00"
            },
            "final_capture": true,
            "seller_protection": {
              "status": "ELIGIBLE",
              "dispute_categories": [
                "ITEM_NOT_RECEIVED",
                "UNAUTHORIZED_TRANSACTION"
              ]
            },
            "seller_receivable_breakdown": {
              "gross_amount": {
                "currency_code": "USD",
                "value": "100.00"
              },
              "paypal_fee": {
                "currency_code": "USD",
                "value": "3.98"
              },
              "net_amount": {
                "currency_code": "USD",
                "value": "96.02"
              }
            },
            "links": [
              {
                "href": "https://api.sandbox.paypal.com/v2/payments/captures/7KY78659SG487110K",
                "rel": "self",
                "method": "GET"
              },
              {
                "href": "https://api.sandbox.paypal.com/v2/payments/captures/7KY78659SG487110K/refund",
                "rel": "refund",
                "method": "POST"
              },
              {
                "href": "https://api.sandbox.paypal.com/v2/checkout/orders/24F22464WC842504J",
                "rel": "up",
                "method": "GET"
              }
            ],
            "create_time": "2021-11-14T23:38:52Z",
            "update_time": "2021-11-14T23:38:52Z"
          }
        ]
      }
    }
  ],
  "payer": {
    "name": {
      "given_name": "FooBuyer",
      "surname": "Jones"
    },
    "email_address": "foobuyer@gmail.com",
    "payer_id": "QYR5Z8XDVJNXQ",
    "address": {
      "country_code": "US"
    }
  },
  "links": [
    {
      "href": "https://api.sandbox.paypal.com/v2/checkout/orders/24F22464WC842504J",
      "rel": "self",
      "method": "GET"
    }
  ]
}

🟠401401 Unauthorized - Invalid Token

🟠403403 Forbidden - Permission Denied

🟠404404 Not Found - Order Not Found

🟠422422 Unprocessable Entity - Action Does Not Match Intent

🟠422422 Unprocessable Entity - Order Already Captured

🟠422422 Unprocessable Entity - Order Not Approved