Cancel unclaimed payout item

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

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Payout to a list of recipients.https://uri.paypal.com/payments/payouts

Path Parameters

payout_item_id*string

The ID of the payout item to cancel.

Match^.*$

Length1 <= length <= 32

Response Body

`application/json`

curl -X POST "https://api-m.paypal.com/v1/payments/v1/payments/payouts-item/string/cancel"

{
  "payout_item_id": "string",
  "transaction_id": "string",
  "activity_id": "string",
  "transaction_status": "SUCCESS",
  "payout_item_fee": {
    "currency": "string",
    "value": "string"
  },
  "payout_batch_id": "string",
  "sender_batch_id": "string",
  "payout_item": {
    "recipient_type": "EMAIL",
    "amount": {
      "currency": "string",
      "value": "string"
    },
    "note": "string",
    "receiver": "string",
    "sender_item_id": "string",
    "recipient_name": {
      "prefix": "string",
      "given_name": "string",
      "surname": "string",
      "middle_name": "string",
      "suffix": "string",
      "alternate_full_name": "string",
      "full_name": "string"
    },
    "recipient_wallet": "PAYPAL",
    "purpose": "AWARDS"
  },
  "currency_conversion": {
    "from_amount": {
      "currency": "string",
      "value": "string"
    },
    "to_amount": {
      "currency": "string",
      "value": "string"
    },
    "exchange_rate": "string"
  },
  "time_processed": "2019-08-24T14:15:22Z",
  "errors": {
    "name": "string",
    "message": "string",
    "debug_id": "string",
    "information_link": "string",
    "details": [
      {
        "field": "string",
        "value": "string",
        "location": "body",
        "issue": "string",
        "description": "string"
      }
    ],
    "links": [
      {
        "href": "string",
        "rel": "string",
        "method": "GET"
      }
    ]
  },
  "links": []
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{ "payout_item_id": "string", "transaction_id": "string", "activity_id": "string", "transaction_status": "SUCCESS", "payout_item_fee": { "currency": "string", "value": "string" }, "payout_batch_id": "string", "sender_batch_id": "string", "payout_item": { "recipient_type": "EMAIL", "amount": { "currency": "string", "value": "string" }, "note": "string", "receiver": "string", "sender_item_id": "string", "recipient_name": { "prefix": "string", "given_name": "string", "surname": "string", "middle_name": "string", "suffix": "string", "alternate_full_name": "string", "full_name": "string" }, "recipient_wallet": "PAYPAL", "purpose": "AWARDS" }, "currency_conversion": { "from_amount": { "currency": "string", "value": "string" }, "to_amount": { "currency": "string", "value": "string" }, "exchange_rate": "string" }, "time_processed": "2019-08-24T14:15:22Z", "errors": { "name": "string", "message": "string", "debug_id": "string", "information_link": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }, "links": [] }

{ "name": "string", "message": "string", "debug_id": "string", "information_link": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }

Cancel unclaimed payout item

Authorization

Path Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

defaultapplication/json

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Cancel unclaimed payout item

Authorization

Path Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`