Capture authorized payment

请求参数

Authorization

在 Header 添加参数

Authorization

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

示例：

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

Path 参数

authorization_id

string

必需

(Required) The PayPal-generated ID for the authorized payment to capture.

示例值:

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

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.

示例值:

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.

示例值:

Body 参数application/json

amount

object

必需

value

string

必需

currency_code

string

必需

invoice_id

string

必需

final_capture

boolean

必需

note_to_payer

string

必需

soft_descriptor

string

必需

示例

{
    "amount": {
        "value": "60",
        "currency_code": "USD"
    },
    "invoice_id": "{{$timestamp}}",
    "final_capture": true,
    "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
    "soft_descriptor": "Bob's Custom Sweaters"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢201201 - Capture Authorized Payment

application/json

Body

string

必需

amount

object

必需

currency_code

string

必需

value

string

必需

final_capture

boolean

必需

seller_protection

object

必需

status

string

必需

seller_receivable_breakdown

object

必需

gross_amount

object

必需

paypal_fee

object

必需

net_amount

object

必需

exchange_rate

object

必需

invoice_id

string

必需

status

string

必需

create_time

string

必需

update_time

string

必需

links

array [object {3}]

必需

href

string

必需

rel

string

必需

method

string

必需

示例

{
    "id": "9FV01025HL4947129",
    "amount": {
        "currency_code": "USD",
        "value": "10.99"
    },
    "final_capture": true,
    "seller_protection": {
        "status": "NOT_ELIGIBLE"
    },
    "seller_receivable_breakdown": {
        "gross_amount": {
            "currency_code": "USD",
            "value": "10.99"
        },
        "paypal_fee": {
            "currency_code": "USD",
            "value": "1.04"
        },
        "net_amount": {
            "currency_code": "USD",
            "value": "9.95"
        },
        "exchange_rate": {}
    },
    "invoice_id": "1644277471",
    "status": "COMPLETED",
    "create_time": "2022-02-07T23:44:31Z",
    "update_time": "2022-02-07T23:44:31Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v2/payments/captures/9FV01025HL4947129",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v2/payments/captures/9FV01025HL4947129/refund",
            "rel": "refund",
            "method": "POST"
        },
        {
            "href": "https://api.sandbox.paypal.com/v2/payments/authorizations/6MU44042UC2498019",
            "rel": "up",
            "method": "GET"
        }
    ]
}

🟠401401 Unauthorized - Invalid Token

🟠401401 Unauthorized - Permission Denied

🟠404404 Not Found - Authorization Not Found

🟠422422 Unprocessable Entity - Authorization Already Captured

⚪0422 Unprocessable Entity - Authorization Voided

🟠422422 Unprocessable Entity - Auth Capture Currency Mismatch

🟠422422 Unprocessable Entity - Max Capture Amount Exceeded