Paypal API
  1. Payouts
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. Payouts

Cancel unclaimed payout item

POST
/v1/payments/payouts-item/{payout_item_id}/cancel
Cancels an unclaimed payout item, by ID. If no one claims the unclaimed item within 30 days, the API automatically returns the funds to the sender. Use this call to cancel the unclaimed item before the automatic 30-day refund. You can cancel payout items with a transaction_status of UNCLAIMED.

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Path 参数
payout_item_id
string 
必需
(Required) The ID of the payout item to cancel.
示例值:
{{unclaimed_payout_item_id}}

示例代码

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/v1/payments/payouts-item/{{unclaimed_payout_item_id}}/cancel' \
--header 'Authorization: Basic Og=='

返回响应

🟢200200 - Cancel Unclaimed Payout Item
application/json
Body
payout_item_id
string 
必需
transaction_id
string 
必需
activity_id
string 
必需
transaction_status
string 
必需
payout_item_fee
object 
必需
currency
string 
必需
value
string 
必需
payout_batch_id
string 
必需
sender_batch_id
string 
必需
payout_item
object 
必需
recipient_type
string 
必需
amount
object 
必需
note
string 
必需
receiver
string 
必需
sender_item_id
string 
必需
recipient_wallet
string 
必需
time_processed
string 
必需
errors
object 
必需
name
string 
必需
message
string 
必需
information_link
string 
必需
details
array
必需
links
array
必需
links
array [object {4}] 
必需
href
string 
必需
rel
string 
必需
method
string 
必需
encType
string 
必需
示例
{
  "payout_item_id": "S697W7QJMAEX4",
  "transaction_id": "0FY48488BY887313U",
  "activity_id": "53C6543893640342P",
  "transaction_status": "RETURNED",
  "payout_item_fee": {
    "currency": "USD",
    "value": "0.25"
  },
  "payout_batch_id": "MJ77GF8MQ2TF6",
  "sender_batch_id": "Payouts_1681157804",
  "payout_item": {
    "recipient_type": "PHONE",
    "amount": {
      "currency": "USD",
      "value": "20.00"
    },
    "note": "Thanks for your support!",
    "receiver": "15562941698",
    "sender_item_id": "201403140002",
    "recipient_wallet": "PAYPAL"
  },
  "time_processed": "2023-04-10T20:16:45Z",
  "errors": {
    "name": "RECEIVER_UNREGISTERED",
    "message": "The recipient for this payout does not have an account. A link to sign up for an account was sent to the recipient. However, if the recipient does not claim this payout within 30 days, the funds will be returned to your account.",
    "information_link": "https://developer.paypal.com/docs/api/payments.payouts-batch/#errors",
    "details": [],
    "links": []
  },
  "links": [
    {
      "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/S697W7QJMAEX4",
      "rel": "self",
      "method": "GET",
      "encType": "application/json"
    },
    {
      "href": "https://api.sandbox.paypal.com/v1/payments/payouts/MJ77GF8MQ2TF6",
      "rel": "batch",
      "method": "GET",
      "encType": "application/json"
    }
  ]
}
🟠401401 Unauthorized - Invalid Token
🟠404404 Not Found - Payout Item Not Found
修改于 2023-08-16 07:18:59
上一页
Show payout item details
下一页
List available events
Built with