Paypal API
  1. Payments
Paypal API
  • Authorization
    • Generate access_token
      POST
    • Terminate access_token
      POST
    • User Info
      GET
    • Generate client_token
      POST
  • Orders
    • Create order
      POST
    • Show order details
      GET
    • Update order
      PATCH
    • Authorize payment for order
      POST
    • Capture payment for order
      POST
  • Payments
    • Show details for authorized payment
      GET
    • Reauthorize authorized payment
      POST
    • Void authorized payment
      POST
    • Capture authorized payment
      POST
    • Show captured payment details
      GET
    • Refund captured payment
      POST
    • Show refund details
      GET
  • Invoices
    • Invoices
      • Generate invoice number
      • Create draft invoice
      • Show invoice details
      • List invoices
      • Generate QR code
      • Fully update invoice
      • Send invoice
      • Send invoice reminder
      • Cancel sent invoice
      • Delete invoice
      • Search for invoices
      • Record payment for invoice
      • Delete external payment
      • Record refund for invoice
      • Delete external refund
    • Templates
      • List templates
      • Create template
      • Show template details
      • Fully update template
      • Delete template
  • Subscriptions
    • Catalog Products
      • Create product
      • List products
      • Show product details
      • Update product
    • Plans
      • Create plan
      • List plans
      • Show plan details
      • Update plan
      • Deactivate plan
      • Activate plan
      • Update pricing
    • Subscriptions
      • Create subscription
      • Show subscription details
      • Update subscription
      • Revise plan or quantity of subscription
      • Suspend subscription
      • Activate subscription
      • Cancel subscription
      • Capture authorized payment on subscription
      • List transactions for subscription
  • Payouts
    • Create batch payout
      POST
    • Show payout batch details
      GET
    • Show payout item details
      GET
    • Cancel unclaimed payout item
      POST
  • Webhooks
    • List available events
    • Create webhook
    • List webhooks
    • Show webhook details
    • List event notifications
    • List event subscriptions for webhook
    • Show event notification details
    • Trigger a sample event
    • Verify webhook signature
    • Resend event notification
    • Simulate webhook event
    • Update webhook
    • Delete webhook
  • Shipment Tracking
    • Add tracking information for multiple PayPal transactions
    • Show tracking information
    • Update or cancel tracking information for PayPal transaction
  • Transaction Search
    • List transactions
    • List all balances
  • Disputes
    • List disputes
    • Show dispute details
    • Accept claim
    • Appeal dispute
    • Settle dispute
    • Update dispute status
    • Make offer to resolve dispute
    • Provide evidence
    • Acknowledge returned item
    • Provide supporting information for dispute
    • Escalate dispute to claim
    • Accept offer to resolve dispute
    • Send message about dispute to other party
    • Deny offer to resolve dispute
    • Partially update dispute
  • Onboarding (Limited Release)
    • Manage Accounts
      • Create managed account
      • Search managed account through external id
      • Search managed account by Seller Id
      • Partially updates information for a managed account
      • Shows collection of registered wallet domains
  1. Payments

Void authorized payment

POST
/v2/payments/authorizations/{authorization_id}/void
Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Path 参数
authorization_id
string 
必需
(Required) The PayPal-generated ID for the authorized payment to void.
示例值:
{{authorization_id}}
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.
示例值:
{{$guid}}
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.
示例值:
{{prefer_representation_detailed}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://api-m.sandbox.paypal.com/v2/payments/authorizations/{{authorization_id}}/void' \
--header 'PayPal-Request-Id: ' \
--header 'Prefer: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og=='

返回响应

🟢200200 - Void The Authorized Payment
application/json
Body
id
string 
必需
status
string 
必需
amount
object 
必需
currency_code
string 
必需
value
string 
必需
seller_protection
object 
必需
status
string 
必需
expiration_time
string 
必需
create_time
string 
必需
update_time
string 
必需
links
array [object {3}] 
必需
href
string 
可选
rel
string 
可选
method
string 
可选
示例
{
    "id": "05M640842N714833V",
    "status": "VOIDED",
    "amount": {
        "currency_code": "USD",
        "value": "100.00"
    },
    "seller_protection": {
        "status": "NOT_ELIGIBLE"
    },
    "expiration_time": "2022-03-09T15:49:55-08:00",
    "create_time": "2022-02-07T15:49:55-08:00",
    "update_time": "2022-02-07T15:50:32-08:00",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v2/payments/authorizations/05M640842N714833V",
            "rel": "self",
            "method": "GET"
        }
    ]
}
🟠401401 Unauthorized - Invalid Token
🟠403403 Forbidden - Permission Denied
🟠422422 Unprocessable Entity - Previously Captured
🟠422422 Unprocessable Entity - Previously Voided
上一页
Reauthorize authorized payment
下一页
Capture authorized payment
Built with