Capture authorized payment on subscription

POST

/v1/billing/subscriptions/{subscription_id}/capture

Captures an authorized payment from the subscriber on the subscription.

请求参数

Authorization

在 Header 添加参数

Authorization

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

示例：

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

Path 参数

Header 参数

Body 参数application/json

示例

{
    "note": "Charging as the balance reached the limit",
    "capture_type": "OUTSTANDING_BALANCE",
    "amount": {
        "currency_code": "USD",
        "value": "100"
    }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api-m.sandbox.paypal.com/v1/billing/subscriptions/{{subscription_id}}/capture' \
--header 'PayPal-Request-Id: ' \
--header 'Prefer: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "note": "Charging as the balance reached the limit",
    "capture_type": "OUTSTANDING_BALANCE",
    "amount": {
        "currency_code": "USD",
        "value": "100"
    }
}'

返回响应

🟠401401 Unauthorized - Invalid Token

application/json

Body

示例

{
    "error": "invalid_token",
    "error_description": "Token signature verification failed"
}

🟠404404 Not Found - Subscription Not Found

🟠422422 Unprocessable Entity - Invalid Subscription Status

🟠422422 Unprocessable Entity - Zero Outstanding Balance

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

Cancel subscription

List transactions for subscription