Paypal API

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 参数

subscription_id

string

必需

示例值:

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 72 hours.

示例值:

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

note

string

必需

capture_type

string

必需

amount

object

必需

currency_code

string

必需

value

string

必需

示例

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

string

必需

error_description

string

必需

示例

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