Capture authorized payment

POST

/v2/payments/authorizations/{authorization_id}/capture

Captures an authorized payment, by ID.

请求参数

Authorization

在 Header 添加参数

Authorization

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

示例：

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

Path 参数

Header 参数

Body 参数application/json

示例

{
    "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

curl --location -g --request POST 'https://api-m.sandbox.paypal.com/v2/payments/authorizations/{{authorization_id}}/capture' \
--header 'PayPal-Request-Id: ' \
--header 'Prefer: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "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"
}'

返回响应

🟢201201 - Capture Authorized Payment

application/json

Body

示例

{
    "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

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

Void authorized payment

Show captured payment details